diff --git a/docs/changelog/fragments/+loc_stack.breaking.rst b/docs/changelog/fragments/+loc_stack.breaking.rst new file mode 100644 index 00000000..78eb1382 --- /dev/null +++ b/docs/changelog/fragments/+loc_stack.breaking.rst @@ -0,0 +1,5 @@ +Due to refactoring of predicate system required for new features: + +1. ``create_request_checker`` was renamed to ``create_loc_stack_checker`` +2. ``LocStackPattern`` (class of ``P``) was renamed ``RequestPattern`` +3. method ``RequestPattern.build_request_checker()`` was renamed to ``LocStackPattern.build_loc_stack_checker()`` diff --git a/docs/changelog/fragments/README.rst b/docs/changelog/fragments/README.rst index 34e251fd..926977af 100644 --- a/docs/changelog/fragments/README.rst +++ b/docs/changelog/fragments/README.rst @@ -1,7 +1,7 @@ This directory contains "news fragments" which are short files that contain a small **ReST**-formatted text that will be added to the next ``CHANGELOG``. -The ``CHANGELOG`` will be read by **users**, so this description should be aimed to pytest users +The ``CHANGELOG`` will be read by **users**, so this description should be aimed to users instead of describing internal changes which are only relevant to the developers. Make sure to use full sentences in the **past or present tense** and use punctuation, examples::