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

Documentation Suggestions #4

Open
ankurankan opened this issue Mar 31, 2021 · 1 comment
Open

Documentation Suggestions #4

ankurankan opened this issue Mar 31, 2021 · 1 comment
Assignees
@D-K-E
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@ankurankan
Copy link

I think the documentation still needs quite a bit of work.

  1. I would really suggest adding more information to the docstrings: expected parameters, examples for using that method etc. I also think sphinx might be a much better option compared to doxygen for python, just in case you haven't checked it out.
  2. I think the method descriptions can be improved as well. Currently, I see a lot of descriptions just pointing to the reference but I think it would be useful if there is a short description in the docstring as well as the reference for more details.

Ref: openjournals/joss-reviews#3115
@D-K-E
Copy link
Owner

D-K-E commented Apr 5, 2021 •
edited
Loading

sphinx might be ...

I tried my hand at sphinx but couldn't manage to configure it. I am also used to doxygen from other projects, so I would like to stick to what I know for now, if you don't think it bothers the user too much. I find that the generated documentation is a little too complex to navigate for a project of this size for example, but I already have a lot of documented code in doxygen markup as well, so I am hesitating to change it now.

more information to docstrings: ... method descriptions ...

I am on it. I hope to finish factor.py by the end of the week. There are several unused functionality as well. I am hoping to clean them up while I am at it.

@D-K-E D-K-E added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 3, 2021
@D-K-E D-K-E pinned this issue May 3, 2021
@D-K-E D-K-E unpinned this issue Jul 28, 2021
@D-K-E D-K-E self-assigned this Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@D-K-E D-K-E

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ankurankan @D-K-E