Skip to content

Commit 4c99de8

Browse files
authored
DOC: Improve docstrings (py-pdf#2690)
1 parent 7710a3c commit 4c99de8

File tree

4 files changed

+11
-10
lines changed

4 files changed

+11
-10
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Please use the templates provided.
1515
We appreciate if people make PRs, but please be aware that pypdf is used by many
1616
people. That means:
1717

18-
* We rarely make breaking changes and have a [deprecation process](https://pypdf.readthedocs.io/en/latest/dev/deprecations.html)
18+
* We rarely make breaking changes and have a [deprecation process](https://pypdf.readthedocs.io/en/latest/dev/deprecations.html).
1919
* New features, especially adding to the public interface, typically need to be
2020
discussed first.
2121

22-
Before you make bigger changes, rather open an issue to make the suggestion.
22+
Before you make bigger changes, open an issue to make the suggestion.
2323
Note which interface changes you want to make.

CONTRIBUTORS.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Contributors
22

3-
pypdf had a lot of contributors since it started with pyPdf in 2005. We are
3+
pypdf had a lot of contributors since it started as pyPdf in 2005. We are
44
a free software project without any company affiliation. We cannot pay
55
contributors, but we do value their contributions. A lot of time, effort, and
6-
expertise went into this project. With this list, we recognize those awesome
6+
expertise went into this project. With this list, we recognize these awesome
77
people 🤗
88

99
The list is definitely not complete. You can find more contributors via the git
10-
history and [GitHubs 'Contributors' feature](https://github.com/py-pdf/pypdf/graphs/contributors).
10+
history and [GitHub's 'Contributors' feature](https://github.com/py-pdf/pypdf/graphs/contributors).
1111

1212
## Contributors to the pypdf (formerly pyPdf / PyPDF2) project
1313

docs/user/adding-pdf-annotations.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -221,8 +221,6 @@ Manage the Popup windows for markups. looks like this:
221221

222222
you can use the {py:class}`Popup <pypdf.annotations.Popup>`:
223223

224-
you have to use the returned result from add_annotation() to fill-up the
225-
226224
```python
227225
from pypdf.annotations import Popup, Text
228226

@@ -249,6 +247,9 @@ popup_annotation = Popup(
249247
writer.write("annotated-pdf-popup.pdf")
250248
```
251249

250+
You have to use the returned result from add_annotation() as it is
251+
the parent annotation with which this popup annotation shall be associated.
252+
252253
## Link
253254

254255
If you want to add a link, you can use
@@ -303,7 +304,7 @@ with open("annotated-pdf.pdf", "wb") as fp:
303304

304305
Text markup annotations refer to a specific piece of text within the document.
305306

306-
Those are a bit more complicated as you need to know exactly where the text
307+
These are a bit more complicated as you need to know exactly where the text
307308
is, the so-called "Quad points".
308309

309310
### Highlighting

pypdf/generic/__init__.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ class AnnotationBuilder:
110110
Instead, use the annotation classes in pypdf.annotations.
111111
112112
See `adding PDF annotations <../user/adding-pdf-annotations.html>`_ for
113-
it's usage combined with PdfWriter.
113+
its usage combined with PdfWriter.
114114
"""
115115

116116
from ..generic._rectangle import RectangleObject
@@ -341,7 +341,7 @@ def ellipse(
341341
interiour_color: Optional[str] = None,
342342
) -> DictionaryObject:
343343
"""
344-
Draw a rectangle on the PDF.
344+
Draw an ellipse on the PDF.
345345
346346
This method uses the /Circle annotation type of the PDF format.
347347

0 commit comments

Comments
 (0)