DOC: Update references and formatting

[j-t-1]

Also OSX --> macOS

[j-t-1]

Have I formatted correctly lines 978-979 and 982-983 of generic/_data_structures.py (i.e. is adding a tab correct)?

The xmp_metadata Returns documentation ({@link #xmp.XmpInformation XmlInformation}) needs changing, how to fix this?

[stefan6419846]

Have I formatted correctly lines 978-979 and 982-983 of generic/_data_structures.py (i.e. is adding a tab correct)?

This depends on how you have configured your tabs - it should map to four whitespace characters.

Apart from this, I recommend you to check the rendered docs locally to verify that everything looks correct. You can do so by installing the package with the docs extras (pip install .[docs]) and then run

pypdf/.github/workflows/github-ci.yaml

Line 172 in bbbc9dd

sphinx-build -n -W --keep-going -T -b html docs build/sphinx/html

You should get a HTML build of the docs you can start browsing by opening the root-level index.html file.

The xmp_metadata Returns documentation ({https://github.com/link #xmp.XmpInformation XmlInformation}) needs changing, how to fix this?

Please we more specific about what you are trying to achieve. In general, the return type is derived from the typing information.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.52%. Comparing base (bbbc9dd) to head (2e5a426).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2529   +/-   ##
=======================================
  Coverage   94.52%   94.52%           
=======================================
  Files          49       49           
  Lines        8178     8178           
  Branches     1659     1659           
=======================================
  Hits         7730     7730           
  Misses        277      277           
  Partials      171      171           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[j-t-1]

Apart from this, I recommend you to check the rendered docs locally to verify that everything looks correct. You can do so by installing the package with the docs extras (pip install .[docs]) and then run

I searched for docs extras, what is the package name to pip install (it is not .doc?)?

The xmp_metadata Returns documentation ({https://github.com/link #xmp.XmpInformation XmlInformation}) needs changing, how to fix this?

Please we more specific about what you are trying to achieve. In general, the return type is derived from the typing information.

The display of the return value in generic.html is wrong, but do not yet know how to correct this reStructuredText.

[stefan6419846]

I searched for docs extras, what is the package name to pip install (it is not .doc?)?

As mentioned before, just run pip install .[docs] from your Git checkout of the repository. This should install the necessary dependencies.

The display of the return value in generic.html is wrong, but do not yet know how to correct this reStructuredText.

Are you looking for something like this?

:class:`~pypdf.xmp.XmpInformation`

[j-t-1]

The display of the return value in generic.html is wrong, but do not yet know how to correct this reStructuredText.

Are you looking for something like this?

:class:`~pypdf.xmp.XmpInformation`

Yes, I have now included this in this commit.