Skip to content

Fix the list of possible types of a VariableStatistics in the docstring#470

Merged
tramora merged 1 commit intodevfrom
463-document-possible-variable-statistics-type
Sep 9, 2025
Merged

Fix the list of possible types of a VariableStatistics in the docstring#470
tramora merged 1 commit intodevfrom
463-document-possible-variable-statistics-type

Conversation

@tramora
Copy link
Copy Markdown
Collaborator

@tramora tramora commented Sep 5, 2025

Fixes #463


TODO Before Asking for a Review

  • Rebase your branch to the latest version of dev (or main for release PRs)
  • Make sure all CI workflows are green
  • When adding a public feature/fix: Update the Unreleased section of CHANGELOG.md (no date)
  • Self-Review: Review "Files Changed" tab and fix any problems you find
  • API Docs (only if there are changes in docstrings, rst files or samples):
    • Check the docs build without warning: see the log of the API Docs workflow
    • Check that your changes render well in HTML: download the API Docs artifact and open index.html
    • If there are any problems it is faster to iterate by building locally the API Docs

Variable name.
type : str
Variable type. Valid values:
Variable type. There are only two valid values for this prepared variable :
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

for this prepared variable : -> for a prepared variable

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Corrected

@tramora tramora force-pushed the 463-document-possible-variable-statistics-type branch from 3ccb4f4 to 32f3d25 Compare September 9, 2025 13:38
@tramora tramora merged commit ec50a84 into dev Sep 9, 2025
12 checks passed
@tramora tramora deleted the 463-document-possible-variable-statistics-type branch September 9, 2025 13:39
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.

Wrong documentation for types in class VariableStatistics

2 participants