Rename create_viewer_preference

[marcstober]

Proposed change to not include create_viewer_preference in the public API. Also fix some docstring typos.

See #2144

[codecov]

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.01% 🎉

Comparison is base (c587cee) 94.34% compared to head (e663e53) 94.36%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2167      +/-   ##
==========================================
+ Coverage   94.34%   94.36%   +0.01%     
==========================================
  Files          43       43              
  Lines        7572     7572              
  Branches     1488     1488              
==========================================
+ Hits         7144     7145       +1     
  Misses        263      263              
+ Partials      165      164       -1     

Files Changed	Coverage Δ
pypdf/_writer.py	88.34% <100.00%> (+0.08%)	⬆️

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

[stefan6419846]

Could you please replace the PR title with some more meaningful one? See https://pypdf.readthedocs.io/en/latest/dev/intro.html#commit-messages for additional information.

[marcstober]

@stefan6419846 sure, this is related to another recent change @pubpub-zz and @MartinThoma have been working on, so it would be good to get their feedback too. I'm not sure if this should also be ENH or STY or something else?

[pubpub-zz]

I'm not fond of creating automatically the view_preference object:
a) it changes the behavior of the function between PdfReader and PdfWriter of viewer_preferences()
b) if you really want to do the action in "one instruction" you just have to do it that way:
v = writer.viewer_preferences or writer.create_viewer_preference()

[marcstober]

@pubpub-zz ok, I updated this pull request with just the rename discussed here: #2105 (comment)

@MartinThoma I think this is ready to merge if it's OK with you and @pubpub-zz now?

I'm not fond of creating automatically the view_preference object: a) it changes the behavior of the function between PdfReader and PdfWriter of viewer_preferences() b) if you really want to do the action in "one instruction" you just have to do it that way: v = writer.viewer_preferences or writer.create_viewer_preference()

[pubpub-zz]

@marcstober
this PR is now obsolete and overwritten by #2190
isn't it ?

[marcstober]

@pubpub-zz yes, I'd originally thought this could be merged first

[pubpub-zz]

duplicate of #2190

[pubpub-zz]

less work for @MartinThoma already over busy 😉