Skip to content

Standardize headings, wording, and inline comments across tutorials#263

Open
jkrick wants to merge 3 commits intoCaltech-IPAC:mainfrom
jkrick:codex/review-tutorial-numbering-and-headings
Open

Standardize headings, wording, and inline comments across tutorials#263
jkrick wants to merge 3 commits intoCaltech-IPAC:mainfrom
jkrick:codex/review-tutorial-numbering-and-headings

Conversation

@jkrick
Copy link
Contributor

@jkrick jkrick commented Feb 25, 2026

Motivation

  • Improve consistency and readability across multiple tutorial notebooks by standardizing section headings and inline prompts.
  • Make user-defined parameter prompts and code comments clearer for readers and notebook users.
  • Add consistent notebook separators and small formatting/admonition fixes to improve rendering and navigation.
  • Fix minor typos and wording to reduce ambiguity when following examples.

Description

  • Renumbered and standardized section headings (added numeric prefixes) across several tutorials including euclid/, simulated-data/, techniques-and-tools/, and wise/.
  • Reworded user-facing prompts and parameter labels (for example replacing ## How large do you want the image cutout to be? with Set the image cutout size) and changed in-code comment markers from ## to # inside code cells for clarity.
  • made small formatting changes to improve markdown rendering.
  • No algorithmic or data-processing logic was changed; updates are documentation and formatting only.

closes #14

@jkrick jkrick self-assigned this Feb 25, 2026
@jkrick jkrick added the documentation Improvements or additions to documentation label Feb 25, 2026
@jkrick jkrick requested a review from bsipocz February 25, 2026 23:28
@jkrick
Copy link
Contributor Author

jkrick commented Feb 25, 2026

This is a codex written PR that I reviewed on my fork and then copied here.
@jaladh-singhal @troyraen just tagging you so you know what I am messing around with.

Copy link
Contributor

@troyraen troyraen left a comment

Choose a reason for hiding this comment

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

Thanks, this will be an improvement. I just have some minor comments.

Copy link
Contributor

Choose a reason for hiding this comment

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

This file got messed up. Numbers are being added to some of the code comments as if they were headings and the actual heading numbers aren't sequential.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

got it.

Co-authored-by: Troy Raen <raen@ipac.caltech.edu>
Copy link
Contributor Author

@jkrick jkrick left a comment

Choose a reason for hiding this comment

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

Thanks for the review @troyraen

Copy link
Contributor Author

Choose a reason for hiding this comment

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

got it.

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

Successfully merging this pull request may close these issues.

Make descriptive section headers

2 participants