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 all .rst files for modules to include explanations of methods #24

Open
5 of 7 tasks
andrewtarzia opened this issue Mar 26, 2024 · 1 comment
Open
5 of 7 tasks
Labels
documentation Improvements or additions to documentation

Comments

@andrewtarzia
Copy link
Contributor

andrewtarzia commented Mar 26, 2024

  • timesoap.rst
  • soapify.rst
  • lens.rst
  • analysis.rst
  • onion
  • data_processing.rst
  • hd5fer.rst

all in docs/source/

@matteobecchi matteobecchi self-assigned this Dec 2, 2024
@matteobecchi matteobecchi added the documentation Improvements or additions to documentation label Dec 2, 2024
@matteobecchi
Copy link
Contributor

I wrote the explanations in all the modules apart from data_processing and hdf5er (I never really understood/used the functions in those modules, and maybe in the future we are removing the hdf5er altogether...).

Should we already PR and merge these (partial) changes, so that everyone can see them and eventually copy the layout for what's missing, and external users have at least a bit of documentation?

@matteobecchi matteobecchi mentioned this issue Dec 3, 2024
@matteobecchi matteobecchi removed their assignment Dec 5, 2024
@andrewtarzia andrewtarzia changed the title Update all .rst files for modules to include explanations of methods. #8 Update all .rst files for modules to include explanations of methods Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants