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

Update for the linking documentation #210

Merged
merged 10 commits into from
Dec 19, 2022

Conversation

snilsn
Copy link
Collaborator

@snilsn snilsn commented Dec 2, 2022

I added some plots and explanations I originally did for my tutorial on the tracking methods to the linking documentation.

  • 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?

@codecov
Copy link

codecov bot commented Dec 2, 2022

Codecov Report

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

Coverage data is based on head (3a3828e) compared to base (aded93d).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##           RC_v1.5.0     #210   +/-   ##
==========================================
  Coverage      41.01%   41.01%           
==========================================
  Files             14       14           
  Lines           2321     2321           
==========================================
  Hits             952      952           
  Misses          1369     1369           
Flag Coverage Δ
unittests 41.01% <ø> (ø)

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.

@freemansw1 freemansw1 added documentation Updates and improvements to documentation and examples Small Change A minor change which should be quick to address and review labels Dec 2, 2022
Copy link
Member

@freemansw1 freemansw1 left a comment

Choose a reason for hiding this comment

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

I think this is a great change; thanks for adding it.

@snilsn
Copy link
Collaborator Author

snilsn commented Dec 5, 2022

I deleted a duplicate picture and corrected a typo. The updated page of the documentation can be found here: https://tobac--210.org.readthedocs.build/en/210/linking.html

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.

Looks great! This is a really helpful contribution @snilsn, approved!

@freemansw1 freemansw1 added this to the Version 1.5 milestone Dec 8, 2022
@freemansw1
Copy link
Member

With two approving reviews, I'm happy to merge if you're happy for it to be merged @snilsn

@snilsn
Copy link
Collaborator Author

snilsn commented Dec 11, 2022

@freemansw1 After some feedback from @fsenf I increased some font sizes. Happy to merge now!

@freemansw1 freemansw1 merged commit 89df5e9 into tobac-project:RC_v1.5.0 Dec 19, 2022
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 Small Change A minor change which should be quick to address and review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants