Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for PdfWriter.open_destination #1493

Open
MasterOdin opened this issue Dec 12, 2022 · 0 comments · May be fixed by #3013
Open

Improve documentation for PdfWriter.open_destination #1493

MasterOdin opened this issue Dec 12, 2022 · 0 comments · May be fixed by #3013
Labels
nf-documentation Non-functional change: Documentation

Comments

@MasterOdin
Copy link
Member

The PdfWriter.open_destination docs isn't parsed "right" and so looks a bit incorrect:

Screenshot 2022-12-12 at 8 48 02 AM

Looking at the other @property values, it doesn't seem like having a :param: though is the right way to go, and so should that be removed? I'd also want to eliminate 1-2 of the /OpenAction references as it feels very repetitive. Maybe something like:

        """
        Property to access the opening destination ("/OpenAction" entry in the
        PDF catalog). This can be set to either Destination, Page, or a string
        (NamedDest) to open to that destination, or None for no open
        destination.
        """

Happy to open the PR for this, but figure an issue is a better quick vehicle to get initial feedback on what's desired for the block.

@MasterOdin MasterOdin added the nf-documentation Non-functional change: Documentation label Dec 12, 2022
stefan6419846 added a commit to stefan6419846/pypdf that referenced this issue Dec 20, 2024
@stefan6419846 stefan6419846 linked a pull request Dec 20, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
nf-documentation Non-functional change: Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant