Skip to content

STY: Docstring formatting#1033

Merged
MartinThoma merged 4 commits intomainfrom
pep-257
Jun 28, 2022
Merged

STY: Docstring formatting#1033
MartinThoma merged 4 commits intomainfrom
pep-257

Conversation

@MartinThoma
Copy link
Copy Markdown
Member

@MartinThoma MartinThoma commented Jun 28, 2022

  • rtype was removed in most cases. It makes sense sometimes, but only if it is not exactly what the type annotation is
  • No newlines after the function docstring
  • Keep lines under 80 characters. It's mostly not an issue for docstrings.

See PEP-257 for some guides.

flake8-naming was used to find those spots.

See PEP-257 for some guides.

flake8-naming was used to find those spots.
@codecov
Copy link
Copy Markdown

codecov bot commented Jun 28, 2022

Codecov Report

Merging #1033 (202279f) into main (c7d2450) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1033   +/-   ##
=======================================
  Coverage   89.60%   89.60%           
=======================================
  Files          24       24           
  Lines        4425     4425           
  Branches      914      914           
=======================================
  Hits         3965     3965           
  Misses        314      314           
  Partials      146      146           
Impacted Files Coverage Δ
PyPDF2/_merger.py 88.80% <ø> (ø)
PyPDF2/_page.py 90.93% <ø> (ø)
PyPDF2/_security.py 94.80% <ø> (ø)
PyPDF2/_writer.py 88.90% <ø> (ø)
PyPDF2/constants.py 100.00% <ø> (ø)
PyPDF2/errors.py 100.00% <ø> (ø)
PyPDF2/filters.py 83.71% <ø> (ø)
PyPDF2/pagerange.py 100.00% <ø> (ø)
PyPDF2/xmp.py 88.83% <ø> (ø)
PyPDF2/_encryption.py 74.86% <100.00%> (ø)
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c7d2450...202279f. Read the comment docs.

@MartinThoma MartinThoma merged commit a89ff74 into main Jun 28, 2022
@MartinThoma MartinThoma deleted the pep-257 branch June 28, 2022 15:32
MartinThoma added a commit that referenced this pull request Jun 30, 2022
New Features (ENH):
-  Add writer.pdf_header property (getter and setter) (#1038)

Performance Improvements (PI):
-  Remove b_ call in FloatObject.write_to_stream (#1044)
-  Check duplicate objects in writer._sweep_indirect_references (#207)

Documentation (DOC):
-  How to surppress exceptions/warnings/log messages (#1037)
-  Remove hyphen from lossless (#1041)
-  Compression of content streams (#1040)
-  Fix inconsistent variable names in add-watermark.md (#1039)
-  File size reduction
-  Add CHANGELOG to the rendered docs (#1023)

Maintenance (MAINT):
-  Handle XML error when reading XmpInformation (#1030)
-  Deduplicate Code / add mutmut config (#1022)

Code Style (STY):
-  Use unnecessary one-line function / class attribute (#1043)
-  Docstring formatting (#1033)

Full Changelog: 2.4.0...2.4.1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant