Skip to content

Conversation

@charcey
Copy link
Contributor

@charcey charcey commented Feb 25, 2025

Related Issue(s):

Closes #

Proposed Changes:

For inclusion in changelog (if applicable):

Not intended for changelog:

  1. Updated doc string for correct doc generation

Diff of User Interface

Old behavior:
image
(args should be parameters and formatted to a table)
New behavior:
Args will be formatted correctly in doc generation

PR Checklist:

  • This PR is as small and focused as possible
  • If this PR includes proposed changes for inclusion in the changelog, the title of this PR summarizes those changes and is ready for inclusion in the Changelog.
  • I have updated docstrings for function changes and docs in the 'docs' folder for user interface / behavior changes
  • This PR does not break any examples or I have updated them

(Optional) @mentions for Notifications:

@charcey charcey merged commit 187611c into main Feb 25, 2025
9 checks passed
@charcey charcey deleted the cp/fix-doc branch February 25, 2025 18:25
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