Skip to content
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

Add doc examples #14

Merged
merged 1 commit into from
Sep 22, 2022
Merged

Add doc examples #14

merged 1 commit into from
Sep 22, 2022

Conversation

nstarman
Copy link
Owner

@nstarman nstarman commented Sep 22, 2022

Description

Starts building the documentation.

PR Checklist

  • Check out the contributing guidelines and code of conduct
  • Check out the contributing workflow ( for a practical example click here )
  • Give a detailed description of the PR above.
  • Document changes in the CHANGES.rst file. See existing changelog for examples.
  • Add tests, if applicable, to ensure code coverage never decreases.
  • Make sure the docs are up to date, if applicable, particularly the docstrings and RST files in docs folder.
  • Ensure linear history by rebasing, when requested by the maintainer.

@codecov
Copy link

codecov bot commented Sep 22, 2022

Codecov Report

Base: 84.74% // Head: 84.74% // No change to project coverage 👍

Coverage data is based on head (fe176ac) compared to base (e3f47cc).
Patch has no changes to coverable lines.

❗ Current head fe176ac differs from pull request most recent head f2e142d. Consider uploading reports for the commit f2e142d to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #14   +/-   ##
=======================================
  Coverage   84.74%   84.74%           
=======================================
  Files           6        6           
  Lines         177      177           
=======================================
  Hits          150      150           
  Misses         27       27           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Signed-off-by: nstarman <nstarkman@protonmail.com>
@nstarman nstarman merged commit b58e958 into main Sep 22, 2022
@nstarman nstarman deleted the add-doc-examples branch September 22, 2022 23:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant