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

Feature/documentation #20

Merged
merged 16 commits into from
Jun 3, 2022
Merged

Feature/documentation #20

merged 16 commits into from
Jun 3, 2022

Conversation

nuclearGoblin
Copy link
Collaborator

Does your pull request resolve or partially resolve an issue?
Yes.

If Yes, which issue?
Resolves #13.

Does your pull request implement code improvements?
No.

Does your pull request implement any breaking changes?
No.

If breaking changes are implemented, please describe:

Testing:
This pull request:

  • Alters the existing CI in some way.
  • Adds a new step to the CI.
  • Does not introduce any features that the CI could not already test.
  • Is not accompanied by necessary CI changes due to some limitation described below. (Please also describe how new features can be manually tested.)

@nuclearGoblin nuclearGoblin self-assigned this Jun 3, 2022
@nuclearGoblin nuclearGoblin linked an issue Jun 3, 2022 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented Jun 3, 2022

Codecov Report

Merging #20 (d8e7df4) into develop (fc7cd53) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop      #20   +/-   ##
========================================
  Coverage    65.49%   65.49%           
========================================
  Files           12       12           
  Lines         1339     1339           
  Branches       131      131           
========================================
  Hits           877      877           
  Misses         434      434           
  Partials        28       28           

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 fc7cd53...d8e7df4. Read the comment docs.

@nuclearGoblin nuclearGoblin merged commit 850a0b2 into develop Jun 3, 2022
@nuclearGoblin nuclearGoblin deleted the feature/documentation branch June 3, 2022 17:42
@nuclearGoblin nuclearGoblin mentioned this pull request Jun 9, 2022
nuclearGoblin added a commit that referenced this pull request Jun 9, 2022
## Release (v1.0.2) Date 06.09.22

More thorough documentation, including updates to the paper.
* PR #19 added coverage data and badges.
* PR #20 created documentation for the notebooks to be used for the workshop.
* PR #21 completed a draft of the paper for author comments period.
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.

Document the Code
4 participants