Skip to content

Conversation

@gisellerosetta
Copy link
Contributor

Proposed Changes

  • Reformats the basic usage example to be chunked up
  • Combines some parts of the code to try and make it look a little simpler
  • Rewrites some commentary
  • Adds a picture
  • Renames files to be more consistent/easier to navigate

Related Issues

Pre-requisites

This section may not be fully required if the branch is not merging into main.
Please indicate items that aren't necessary and why, with comments around incomplete checks.

  • Version number has been incremented, according to SemVer NA
  • Changelog has been updated, listing changes to this version. Use the keep a changelog format NA
  • New features are tested NA
  • New features are documented using the numpydoc docstring format NA
  • Other relevant package documentation is updated
  • For new functionality, examples are included in the docs or a feature request has
    been made for it/them. NA

@gisellerosetta gisellerosetta self-assigned this Oct 17, 2025
@gisellerosetta gisellerosetta linked an issue Oct 17, 2025 that may be closed by this pull request
2 tasks
@gisellerosetta gisellerosetta marked this pull request as ready for review October 17, 2025 09:40
@ldavies99 ldavies99 self-requested a review October 20, 2025 11:36
Copy link
Contributor

@ldavies99 ldavies99 left a comment

Choose a reason for hiding this comment

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

Revised getting started guide looks clear and easy to follow. Happy for this to merge.

@ldavies99 ldavies99 merged commit 0eb38a8 into dev Oct 20, 2025
11 of 12 checks passed
@ldavies99 ldavies99 deleted the 302-basic-example branch October 20, 2025 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update basic usage example

3 participants