-
Notifications
You must be signed in to change notification settings - Fork 64
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
docs: Add links and more discussion to examples. #227
docs: Add links and more discussion to examples. #227
Conversation
2 similar comments
@eliotwrobson I saw a new commit just now—are you still working on this? Let me know when it's ready for my review and I'll have a look! |
@caleb531 just added some finishing touches to the docs based on some additional review comments that came in since this PR was still open. Should be good to review, and once this is merged we should be able to push along the review 👍🏽 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@eliotwrobson This looks very good! Added some comments with a few grammatical corrections—apologies if they seem rather nitpicky 😅.
Co-authored-by: Caleb Evans <caleb@calebevans.me>
@caleb531 no worries, being nitpicky usually pays off when reviewing documentation IMO. I've committed all of your changes, if all looks good I'll go ahead and merge soon! |
@eliotwrobson Yep, looks great now! Approved! |
@caleb531 Resolves #226 and adds links to examples and the front page as requested in #212. I think this adds enough additional discussion that we can close #212, as this adds links to other pages and lecture notes that cover the theory in detail.
However, we will still add the planned notebooks with extended teaching examples, likely to their own section on the docs site.
Responding to items on pyOpenSci/software-submission#152