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 documentation #27

Merged
merged 5 commits into from
Jul 12, 2022
Merged

Update documentation #27

merged 5 commits into from
Jul 12, 2022

Conversation

itepifanio
Copy link
Collaborator

This MR updates the README.md and API docs.

  • Improved the statement of need on the README.md
  • Added follow-up instructions after the installation section
  • Remove hard-coded dependencies from README.md
  • Enhancements were made in the API docs section, explaining better the imports and all modules related.
  • Added section explaining how to run the tests

@ibayer I'll open a second PR to address the JOSS feedback on the paper.

Copy link
Member

@ibayer ibayer left a comment

Choose a reason for hiding this comment

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

@itepifanio LGTM I have just added a few suggestions for minor edits.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@ibayer ibayer merged commit 97bf194 into palaimon:main Jul 12, 2022
@ibayer
Copy link
Member

ibayer commented Jul 12, 2022

@itepifanio 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.

2 participants