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

Added some details to options documentation #55

Merged
merged 2 commits into from
Oct 11, 2021
Merged

Conversation

sseraj
Copy link
Collaborator

@sseraj sseraj commented Oct 5, 2021

Purpose

I added some details to the options documentation which will hopefully help users understand how to use certain options.

I also added the Codecov badge to the README because I forgot to do that in #48.

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

Checklist

  • I have run flake8 and black to make sure the code adheres to PEP-8 and is consistently formatted
  • I have run unit and regression tests which pass locally with my changes
  • I have added new tests that prove my fix is effective or that my feature works
  • I have added necessary documentation

@sseraj sseraj requested a review from a team as a code owner October 5, 2021 19:26
@codecov
Copy link

codecov bot commented Oct 5, 2021

Codecov Report

Merging #55 (affc929) into master (fbfb428) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #55   +/-   ##
=======================================
  Coverage   76.37%   76.37%           
=======================================
  Files           3        3           
  Lines         364      364           
=======================================
  Hits          278      278           
  Misses         86       86           

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 fbfb428...affc929. Read the comment docs.

@sseraj sseraj merged commit 39e4a0d into master Oct 11, 2021
@sseraj sseraj deleted the options-details branch October 11, 2021 14:04
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