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

Updates to README.md #197

Merged
merged 4 commits into from
Oct 31, 2022

Conversation

freemansw1
Copy link
Member

@freemansw1 freemansw1 commented Oct 26, 2022

This will resolve #58 and also contains more general updates to our README, including changing URLs and updating our contributing section.

  • Have you followed our guidelines in CONTRIBUTING.md?
  • Have you self-reviewed your code and corrected any misspellings?
  • Have you written documentation that is easy to understand?
  • Have you written descriptive commit messages?
  • Have you added NumPy docstrings for newly added functions?
  • Have you formatted your code using black?
  • If you have introduced a new functionality, have you added adequate unit tests?
  • Have all tests passed in your local clone?
  • If you have introduced a new functionality, have you added an example notebook?
  • Have you kept your pull request small and limited so that it is easy to review?
  • Have the newest changes from this branch been merged?

@freemansw1 freemansw1 added the documentation Updates and improvements to documentation and examples label Oct 26, 2022
@freemansw1 freemansw1 added this to the Version 1.4 milestone Oct 26, 2022
@codecov
Copy link

codecov bot commented Oct 26, 2022

Codecov Report

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

Coverage data is based on head (200dc1d) compared to base (0744e06).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##           RC_v1.4.0     #197   +/-   ##
==========================================
  Coverage      36.22%   36.22%           
==========================================
  Files             10       10           
  Lines           2120     2120           
==========================================
  Hits             768      768           
  Misses          1352     1352           
Flag Coverage Δ
unittests 36.22% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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.

Copy link
Member

@JuliaKukulies JuliaKukulies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great update @freemansw1! I have nothing to comment on except for one typo that has been there before but we may as well fix it with this PR

l. 20 Individual features are indentified -> Individual features are identified

@freemansw1
Copy link
Member Author

Good catch @JuliaKukulies! This has been fixed.

Copy link
Collaborator

@snilsn snilsn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice revision @freemansw1! I have nothing to add.

@freemansw1 freemansw1 merged commit 720ef18 into tobac-project:RC_v1.4.0 Oct 31, 2022
@freemansw1 freemansw1 deleted the update_readme_v14 branch November 30, 2022 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Updates and improvements to documentation and examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants