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

Stage and pipeline related documentation touch ups #780

Merged
merged 1 commit into from
Jul 26, 2024

Conversation

thehrh
Copy link
Contributor

@thehrh thehrh commented Jul 25, 2024

A few small things that I encountered while trying to get up to speed with core functionality:

  • pipeline.py main script docstring adapted (broken, needs to be fixed or removed)
  • stage base class: docstring updated
    • no cake vs. pi distinction anymore, right? ("pisa pi" still mentioned in a few other places, but meaning not necessarily clear to a newcomer)
    • lacking effect of promised effect of debug_mode as far as I can tell
    • missing parameters error_method and profile, and other superficial things
    • also cleaned up some left-over references to removed objects in comments
  • updated table of directory contents in stages/README.MD (and added expected_params to list of std_kwargs)
  • given the importance of the concept, expanded introductory text on pisa (stage) modes in pisa_examples/pisa_modes.ipynb (reflects my understanding, felt like the prior version was a bit too brief)

… updated (no cake vs. pi distinction anymore, lacking effect of debug_mode, missing parameter error_method and profile, and minor) and cleaned up some references to removed objects in comments; minor fixes in stages/README.MD; expanded introductory text on pisa (stage) modes in pisa_examples/pisa_modes.ipynb due to importance
@LeanderFischer LeanderFischer self-requested a review July 26, 2024 05:57
Copy link
Collaborator

@LeanderFischer LeanderFischer left a comment

Choose a reason for hiding this comment

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

Hey, thanks a lot for the detailed checks and additions! Looks very good to me and definitely enhances the documentation 🔥 Since I set up a workflow to automatically create the docu recently, that will immediately go in, once merged.

@LeanderFischer LeanderFischer merged commit 39abb5c into icecube:master Jul 26, 2024
2 checks passed
@thehrh thehrh deleted the update_core_doc branch July 26, 2024 10:10
@thehrh
Copy link
Contributor Author

thehrh commented Jul 26, 2024

Cool, I can see it there already.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants