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

Documentation fixes #20

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Yash-10
Copy link
Contributor

@Yash-10 Yash-10 commented May 25, 2021

This pull request explicitly redirects to main rather than master for links on README, since the default branch was updated to main.

Additionally, I found that running:

nbkode.get_solvers('euler', 'adam-bashforth')

from the latest docs gives a key error. It seems that there was a missing s in adam-bashforth.

Question
Since the output after running:

>>> nbkode.get_groups()
('Adams-Bashforth', 'Adams-Moulton', 'BDF', 'Euler', 'Runge-Kutta')

is the above, would it be a good choice to change as per the below:

- nbkode.get_solvers('euler', 'adam-bashforth')
+ nbkode.get_solvers('Euler', 'Adams-Bashforth')

The latest commit tries to include link to the documentation as per #21 .

Thanks!

@Yash-10 Yash-10 changed the title Redirect AUTHORS, CHANGES to main in README Redirect links to main in README, Fix typo in group name in docs May 25, 2021
Add documentation link in README

Revert "Add documentation link in README"

This reverts commit c005360.
@Yash-10 Yash-10 force-pushed the README-link-redirection-to-main branch from d906eb3 to cfba7db Compare May 27, 2021 16:37
@Yash-10 Yash-10 changed the title Redirect links to main in README, Fix typo in group name in docs Documentation fixes May 30, 2021
@Yash-10
Copy link
Contributor Author

Yash-10 commented Jun 9, 2021

@hgrecco Could you take a look at this?

Thanks!

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.

1 participant