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

Issues/90 - add documentation #92

Merged
merged 46 commits into from
Feb 2, 2019
Merged

Issues/90 - add documentation #92

merged 46 commits into from
Feb 2, 2019

Conversation

komuw
Copy link
Owner

@komuw komuw commented Jan 29, 2019

Thank you for contributing to naz.
Every contribution to naz is important.

Contributor offers to license certain software (a “Contribution” or multiple
“Contributions”) to naz, and naz agrees to accept said Contributions,
under the terms of the MIT License.
Contributor understands and agrees that naz shall have the irrevocable and perpetual right to make
and distribute copies of any Contribution, as well as to create and distribute collective works and
derivative works of any Contribution, under the MIT License.

Now,

What(What have you changed?)

  • add proper documentation
  • Start tracking changes in a changelog
  • Add more type hints
  • run mypy across the entire repo

How

screen shot 2019-01-31 at 16 45 47

Why(Why did you change it?)

References:

@codecov-io
Copy link

codecov-io commented Jan 29, 2019

Codecov Report

Merging #92 into master will decrease coverage by 0.17%.
The diff coverage is 96.62%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #92      +/-   ##
==========================================
- Coverage   85.41%   85.23%   -0.18%     
==========================================
  Files          10       12       +2     
  Lines         898      901       +3     
==========================================
+ Hits          767      768       +1     
- Misses        131      133       +2
Impacted Files Coverage Δ
naz/q.py 78.57% <ø> (ø) ⬆️
naz/__version__.py 100% <ø> (ø) ⬆️
naz/throttle.py 91.83% <ø> (ø) ⬆️
naz/sequence.py 84.61% <ø> (ø) ⬆️
naz/hooks.py 81.25% <ø> (ø) ⬆️
naz/correlater.py 93.1% <100%> (ø) ⬆️
naz/ratelimiter.py 96.96% <100%> (ø) ⬆️
cli/cli.py 70.07% <100%> (ø) ⬆️
naz/logger.py 100% <100%> (ø)
naz/state.py 100% <100%> (ø)
... and 4 more

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 08a4e78...8687e28. Read the comment docs.

@komuw komuw changed the title Issues/90 Issues/90 - add documentation Feb 1, 2019
@komuw komuw merged commit 02c091f into master Feb 2, 2019
@komuw komuw deleted the issues/90 branch February 2, 2019 05:25
@komuw komuw mentioned this pull request Feb 2, 2019
@komuw
Copy link
Owner Author

komuw commented Feb 2, 2019

Documentation is now available at: https://naz.komu.engineer/

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.

add proper documentation
2 participants