Skip to content

Conversation

@owenlittlejohns
Copy link
Member

Description

This PR adds some documentation clarification following feedback from @asteiker after using the library as a new user.

Jira Issue ID

N/A

Local Test Steps

  • Read the new content and make sure it makes sense.

PR Acceptance Checklist

  • Acceptance criteria met
  • Tests added/updated (if needed) and passing
  • Documentation updated (if needed)
  • CHANGELOG updated with the changes for this PR
  • Package's __about__.py file changed if a new version should be published.

@owenlittlejohns
Copy link
Member Author

@asteiker - I can't add you as a reviewer for the pull request (probably because you aren't a maintainer for the repository), but let me know if this looks good with a comment.

Copy link
Member

@flamingbear flamingbear left a comment

Choose a reason for hiding this comment

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

This looks good to me.

@asteiker
Copy link

@owenlittlejohns Thank you for adding more to the Readme! This looks great. I unofficially approve. 😄

@owenlittlejohns owenlittlejohns merged commit dca1d91 into main Sep 17, 2025
5 checks passed
@owenlittlejohns owenlittlejohns deleted the eh-docs-skipping-metadata branch September 17, 2025 18:41
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.

3 participants