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.

Sign up for GitHub

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

Jump to bottom

Improve content in documentation pages #13

Closed
joaopfonseca opened this issue Dec 12, 2023 · 0 comments · Fixed by #52
Closed

Improve content in documentation pages #13

joaopfonseca opened this issue Dec 12, 2023 · 0 comments · Fixed by #52
Assignees
@akhynkokateryna
Labels
Documentation Improvements or additions to documentation

Comments

@joaopfonseca
Copy link
Member

Describe the issue linked to the documentation

Several classes/functions are not (properly) documented. It's important to go though all the contents and improve the descriptions of the different functions and classes, as well as arguments' descriptions.

Suggest a potential alternative/fix

No response
@joaopfonseca joaopfonseca added the Documentation Improvements or additions to documentation label Dec 12, 2023
@joaopfonseca joaopfonseca changed the title Improve contents in documentation pages Improve content in documentation pages Dec 15, 2023
joaopfonseca added a commit that referenced this issue Feb 20, 2024
@joaopfonseca
DOC add more information + fix incorrect info (#13)
3fdcb28
joaopfonseca added a commit that referenced this issue Nov 13, 2024
@joaopfonseca
EXA edit text content and fix plots formatting (#13)
1204541
joaopfonseca added a commit that referenced this issue Nov 13, 2024
@joaopfonseca
EXA edit text content and fix plots formatting (#13)
6660f05
@akhynkokateryna akhynkokateryna mentioned this issue Nov 21, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@akhynkokateryna akhynkokateryna

Labels
Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve documentation akhynkokateryna/ShaRP
3 participants
@venetiap @joaopfonseca @akhynkokateryna