Skip to content

Update docs and add doctest loading mechanism #467

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 23 commits into from
Mar 27, 2021
Merged

Update docs and add doctest loading mechanism #467

merged 23 commits into from
Mar 27, 2021

Conversation

althonos
Copy link
Member

@althonos althonos commented Mar 25, 2021

Type of changes

  • Documentation / docstrings
  • Tests

Checklist

  • I've run the latest black with default args on new code.
  • I've updated CHANGELOG.md and CONTRIBUTORS.md where appropriate.
  • I've added tests for new code.
  • I accept that @PyFilesystem/maintainers may be pedantic in the code review.

Description

This PR addresses some documentation issues. I also added a unittest loader so that the documentation examples are now tested with the other unit tests. This will prevent the documentation from having out-of-date examples.

@althonos althonos added enhancement docs Issues related to documentation labels Mar 25, 2021
@althonos althonos changed the title Update docs Update docs and add doctest loading mechanism Mar 25, 2021
@coveralls
Copy link

coveralls commented Mar 25, 2021

Coverage Status

Coverage decreased (-0.01%) to 95.355% when pulling 41bbe3c on update-docs into e6f0c8f on master.

@althonos althonos force-pushed the update-docs branch 2 times, most recently from ca5e495 to b67d49e Compare March 25, 2021 21:59
@althonos althonos added this to the v2.4.13 milestone Mar 26, 2021
@althonos althonos marked this pull request as ready for review March 26, 2021 16:32
@althonos althonos force-pushed the update-docs branch 3 times, most recently from a57b857 to d50a7ae Compare March 27, 2021 02:42
@althonos althonos merged commit 2827cb0 into master Mar 27, 2021
@althonos althonos deleted the update-docs branch March 27, 2021 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment