Skip to content

Add example derivation rules#466

Merged
popescu-v merged 2 commits intodevfrom
408-add-example-to-the-rule-specification-docstring-of-the-variable-class
Sep 2, 2025
Merged

Add example derivation rules#466
popescu-v merged 2 commits intodevfrom
408-add-example-to-the-rule-specification-docstring-of-the-variable-class

Conversation

@popescu-v
Copy link
Copy Markdown
Collaborator

@popescu-v popescu-v commented Sep 1, 2025

closes #408


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

@popescu-v popescu-v linked an issue Sep 1, 2025 that may be closed by this pull request
@popescu-v popescu-v requested a review from tramora September 1, 2025 14:27
@popescu-v popescu-v force-pushed the 408-add-example-to-the-rule-specification-docstring-of-the-variable-class branch 2 times, most recently from bfc968a to 847f246 Compare September 1, 2025 15:33
Copy link
Copy Markdown
Collaborator

@tramora tramora left a comment

Choose a reason for hiding this comment

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

Looks good to me

@popescu-v popescu-v force-pushed the 408-add-example-to-the-rule-specification-docstring-of-the-variable-class branch from 847f246 to 14127f4 Compare September 2, 2025 08:53
Derivation rule. Set to "" if there is no rule associated to this
variable. Examples:
- standard rule: "Sum(Var1, Var2)"
- reference rule: "[Identifier]"
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.

Identifier -> TableName

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.

Since we are improving this part I'd also put "Derivation rule or external table reference".

External references are not rules.

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.

Good point! I'll change accordingly.

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.

Done & Done.

Before this patch, some of them were being displayed on the same line.
@popescu-v popescu-v force-pushed the 408-add-example-to-the-rule-specification-docstring-of-the-variable-class branch from 14127f4 to d8a1204 Compare September 2, 2025 09:46
@popescu-v popescu-v merged commit d47193a into dev Sep 2, 2025
12 checks passed
@popescu-v popescu-v deleted the 408-add-example-to-the-rule-specification-docstring-of-the-variable-class branch September 2, 2025 09:50
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.

Add Example to the Rule specification Docstring of the Variable class

3 participants