Skip to content

Docstrings improvements for NameID and argtree.add_path #538

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

Merged
merged 2 commits into from
Aug 24, 2018

Conversation

sheilatron
Copy link
Contributor

Making docstrings more explanatory for NameID and argtree.add_path

I ran across these while stepping through tests, and writing docstrings
helps me understand them. Please let me know if you agree/disagree
with the added content. Thanks!

Sphinx docs build output said:

pysaml2/src/saml2/argtree.py:docstring of saml2.argtree.add_path:15: WARNING: Unexpected indentation.

I don't know if that matters, since I did not see any content generated out of docstrings using Sphinx autoclass or autofunction directives.

All Submissions:

  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you added an explanation of what problem you are trying to solve with this PR?
  • Have you added information on what your changes do and why you chose this as your solution?
  • Have you written new tests for your changes?
  • Does your submission pass tests?
  • This project follows PEP8 style guide. Have you run your code against the 'flake8' linter?

@codecov-io
Copy link

codecov-io commented Aug 14, 2018

Codecov Report

Merging #538 into master will decrease coverage by 0.03%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #538      +/-   ##
==========================================
- Coverage   65.52%   65.48%   -0.04%     
==========================================
  Files         103      103              
  Lines       25660    25660              
==========================================
- Hits        16814    16804      -10     
- Misses       8846     8856      +10
Impacted Files Coverage Δ
src/saml2/argtree.py 88.52% <ø> (ø) ⬆️
src/saml2/saml.py 92.28% <ø> (ø) ⬆️
src/saml2/validate.py 74.11% <0%> (-4.71%) ⬇️
src/saml2/__init__.py 86.52% <0%> (+0.18%) ⬆️
src/saml2/time_util.py 87.42% <0%> (+0.59%) ⬆️

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 a17f233...40c5452. Read the comment docs.

@sheilatron
Copy link
Contributor Author

Something seems off with the code coverage job. It's showing code changes which don't belong to this PR, or at least are not included in the two commits.

@c00kiemon5ter c00kiemon5ter merged commit 9eb34a9 into IdentityPython:master Aug 24, 2018
@c00kiemon5ter
Copy link
Member

Thanks!

Regarding the coverage report, I am not sure what is wrong, but I can see what you're saying. I will look into it as time allows.

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.

3 participants