Skip to content

Refresh docstrings for Symbol and ArraySymbol methods#487

Open
JoelPasvolsky wants to merge 8 commits intodwavesystems:mainfrom
JoelPasvolsky:copyedit1
Open

Refresh docstrings for Symbol and ArraySymbol methods#487
JoelPasvolsky wants to merge 8 commits intodwavesystems:mainfrom
JoelPasvolsky:copyedit1

Conversation

@JoelPasvolsky
Copy link
Contributor

@JoelPasvolsky JoelPasvolsky commented Mar 20, 2026

Main things for this PR are consistency across symbols, minimizing users clicking on the Model Symbol links, which is a document deadend, and updating code examples.
Please verify my update for the initial argument in the all and any methods.

(This commit switches to type hints but was reverted: at least in the past, such type hints caused compilation problems, so we can leave this for another PR after some testing.)

@JoelPasvolsky
Copy link
Contributor Author

The CI docs build passes but the generated HTML is not for the PR branch and has warning: @copybrief or @copydoc target 'Node::commit()' not found warnings. Does someone know if this is only for this PR or if it's a general problem? I can make a test PR to find out.

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