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

Broken/missing documentation of analysis #758

Open
LeanderFischer opened this issue Dec 6, 2023 · 2 comments · May be fixed by #770
Open

Broken/missing documentation of analysis #758

LeanderFischer opened this issue Dec 6, 2023 · 2 comments · May be fixed by #770
Assignees
@ggarg07
Labels
bug documentation
Milestone
PISA 4.2

Comments

@LeanderFischer
Copy link
Collaborator

The notebook in the analysis readme is missing. A working notebook and/or at least some sentences on how this should be used are needed.
@LeanderFischer LeanderFischer added this to the PISA 4.2 milestone Dec 6, 2023
@atrettin Slack
Copy link
Contributor

atrettin commented Dec 6, 2023

The README should refer to the documentation that is generated from the docstring: https://user-web.icecube.wisc.edu/~peller/pisa_docs/pisa.analysis.html#pisa.analysis.analysis.BasicAnalysis

@ggarg07 ggarg07 self-assigned this Feb 29, 2024
@ggarg07
Copy link
Contributor

ggarg07 commented Mar 4, 2024

Hii @LeanderFischer.....so are you expecting a notebook to show how to use functions from analysis.py or something else? Can you please explicitly let me know?

@ggarg07 ggarg07 self-assigned this May 17, 2024
@ggarg07 ggarg07 linked a pull request May 18, 2024 that will close this issue
Added a link to the documentation in the readme file #770
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ggarg07 ggarg07

Labels
bug documentation
Projects
None yet
Milestone
PISA 4.2
Development

Successfully merging a pull request may close this issue.

Added a link to the documentation in the readme file ggarg07/pisa
3 participants
@atrettin @LeanderFischer @ggarg07