Improve write_report, compat using @singledispatch #108
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Cache return values; discard cache when .modules changes. - Don't use a result if getattr(…) triggers a warning.
- Make a single-dispatch function for easier overloading. - Pass through keyword arguments; set index=False by default. - Add "header_comment" keyword argument.
Simplify these functions by removing the need to chain the basic operator.
Also address nitpicks where docstrings are reused downstream via intersphinx.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #108 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 48 48
Lines 4043 4102 +59
=========================================
+ Hits 4043 4102 +59
|
khaeru
force-pushed
the
enh/write-report
branch
from
7fcef03 to
f28a095
Compare
khaeru
added a commit
that referenced
this pull request
Nov 28, 2023
khaeru
force-pushed
the
enh/write-report
branch
from
8467252 to
409f29a
Compare
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Use
@functools.singledispatch()to simplify these operators and make them more easily extensible.Housekeeping
nitpicky = Truein Sphinx configuration and address most nitpicks.PR checklist