diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md index f23ab0bcc..70cf81297 100644 --- a/docs/dev/documentation.md +++ b/docs/dev/documentation.md @@ -53,4 +53,4 @@ The title of the PR will be used as the first line of that combined commit messa The first comment within the commit will be used as the message body. -See [dev intro](intro.html#commit-messages) for more details. +See [developer intro](intro.html#commit-messages) for more details. diff --git a/pypdf/_page_labels.py b/pypdf/_page_labels.py index 1bedc003a..0dce8ec75 100644 --- a/pypdf/_page_labels.py +++ b/pypdf/_page_labels.py @@ -125,7 +125,7 @@ def number2lowercase_letter(number: int) -> str: def get_label_from_nums(dictionary_object: DictionaryObject, index: int) -> str: # [Nums] shall be an array of the form - # [ key 1 value 1 key 2 value 2 ... key n value n ] + # [ key_1 value_1 key_2 value_2 ... key_n value_n ] # where each key_i is an integer and the corresponding # value_i shall be the object associated with that key. # The keys shall be sorted in numerical order, diff --git a/pypdf/_writer.py b/pypdf/_writer.py index 4d4cca329..308c2e9c8 100644 --- a/pypdf/_writer.py +++ b/pypdf/_writer.py @@ -3132,16 +3132,16 @@ def set_page_label( Page indexes must be given starting from 0. Labels must have a style, a prefix or both. - If to a range is not assigned any page label a decimal label starting from 1 is applied. + If a range is not assigned any page label a decimal label starting from 1 is applied. Args: page_index_from: page index of the beginning of the range starting from 0 page_index_to: page index of the beginning of the range starting from 0 style: The numbering style to be used for the numeric portion of each page label: - * ``/D`` Decimal arabic numerals - * ``/R`` Uppercase roman numerals - * ``/r`` Lowercase roman numerals + * ``/D`` Decimal Arabic numerals + * ``/R`` Uppercase Roman numerals + * ``/r`` Lowercase Roman numerals * ``/A`` Uppercase letters (A to Z for the first 26 pages, AA to ZZ for the next 26, and so on) * ``/a`` Lowercase letters (a to z for the first 26 pages, @@ -3180,18 +3180,17 @@ def _set_page_label( """ Set a page label to a range of pages. - Page indexes must be given - starting from 0. Labels must have a style, a prefix or both. If to a - range is not assigned any page label a decimal label starting from 1 is - applied. + Page indexes must be given starting from 0. + Labels must have a style, a prefix or both. + If a range is not assigned any page label a decimal label starting from 1 is applied. Args: page_index_from: page index of the beginning of the range starting from 0 page_index_to: page index of the beginning of the range starting from 0 style: The numbering style to be used for the numeric portion of each page label: - /D Decimal arabic numerals - /R Uppercase roman numerals - /r Lowercase roman numerals + /D Decimal Arabic numerals + /R Uppercase Roman numerals + /r Lowercase Roman numerals /A Uppercase letters (A to Z for the first 26 pages, AA to ZZ for the next 26, and so on) /a Lowercase letters (a to z for the first 26 pages,