Apply docstrings to functions across the library source code #56
Conversation
… py source files in the nlp_profiler folder (the whole of the library)
…mber of .py source files
neomatrix369
added
documentation
Codecov Report
@@ Coverage Diff @@
## master #56 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 379 379
Branches 54 54
=========================================
Hits 379 379
Continue to review full report at Codecov.
|
|
@sourcery-ai in the PR I'm improving the docstrings of each of the function, I think your parser/analyser may want to consider it as an improvement and not consider it as an increase in method-length (so NOT a decrease in code quality as such) -- zero functionality has been changed by this process, and thus zero code has been changed, only comments have been added. And in general, a narration on why there was code quality increase or decrease in the PR can also help -- if that can be ascertained via the diff code. |
neomatrix369
force-pushed
the
apply_doc_strings_to_functions
branch
4 times, most recently
from
f5a9867 to
bc68bb6
Compare
neomatrix369
force-pushed
the
apply_doc_strings_to_functions
branch
from
bc68bb6 to
7e0bea0
Compare
Sourcery Code Quality Report❌ Merging this PR will decrease code quality in the affected files by 0.15%.
Here are some functions in these files that still need a tune-up:
Legend and ExplanationThe emojis denote the absolute quality of the code:
The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request. Please see our documentation here for details on how these metrics are calculated. We are actively working on this report - lots more documentation and extra metrics to come! Let us know what you think of it by mentioning @sourcery-ai in a comment. |
|
@shubhadeep let's discuss improvements and feedback on this PR that I used |
neomatrix369
force-pushed
the
master
branch
2 times, most recently
from
f2e57f3 to
2663a11
Compare
To be able to merge a pull request, there are a few checks:
Goal or purpose of the PR
Primarily using docly and applying it to all the source files of the whole library. A number of source files were missed due to errors generated during parsing by
doclyissue(s) to be raised with founders as part of the feedback program.Changes implemented in the PR
Ran
docly-genon all the source files using the shell scriptapply-docstrings-to-functions.shApplied manual changes to a number of docstrings to make them more readable. And also captures issues with docly when trying to parse a handful of source files -- as a separate commit to make it easier to compare the before and after actions of using
doclyto generate docstrings.docly-issues.txt contains a list of all the errors that occurred when tryingto parse the source file as a result no docstrings were generated for them.
To make
doclya bit easier to use, there could an additional CLI arg i.e.--quietand/or-yto allow defaulting to applying docstrings that it suggests. Also the--helpcould be a bit more clearer (maybe also provide an example or two).