Skip to content

List all possible variable types in class Variable docstring#452

Merged
tramora merged 1 commit intodevfrom
440-document-possible-variable-types
Sep 4, 2025
Merged

List all possible variable types in class Variable docstring#452
tramora merged 1 commit intodevfrom
440-document-possible-variable-types

Conversation

@tramora
Copy link
Copy Markdown
Collaborator

@tramora tramora commented Aug 14, 2025

Fixes #440


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

@tramora tramora force-pushed the 440-document-possible-variable-types branch from 4683aa5 to 7aca86b Compare August 14, 2025 10:43
@tramora tramora force-pushed the 440-document-possible-variable-types branch 4 times, most recently from 3bfdc95 to 397f77a Compare August 24, 2025 22:38
@tramora tramora force-pushed the 440-document-possible-variable-types branch 3 times, most recently from 884be94 to 1a2045e Compare September 3, 2025 14:06
@tramora tramora requested review from popescu-v September 3, 2025 14:21
var.type = var_spec["type"]
root_dictionary.add_variable(var)

# Creates a second dictionary (not linked yet)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

s/Creates/Create/

"(not linked yet)": what does this mean?

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.

typo fixed.

The link is created when a Entity or Table variable is added but if it is confusing I will remove it

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

typo fixed.

The link is created when a Entity or Table variable is added but if it is confusing I will remove it

Yes, I would remove the text between the parentheses (as the "link" concept is not defined).

Copy link
Copy Markdown
Collaborator

@popescu-v popescu-v left a comment

Choose a reason for hiding this comment

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

See the comments.

@tramora tramora force-pushed the 440-document-possible-variable-types branch 2 times, most recently from ac7bd7c to 5344e67 Compare September 3, 2025 16:33
@tramora tramora requested a review from popescu-v September 3, 2025 16:33
kh.Variable(json_data={"name": "id_city", "type": "Categorical"})
)

# Add the variables used in a Multi-tables context in the first dictionary.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

s/Multi-tables/multi-table/ (for coherence with other occurrences in the samples).

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.

Fixed

Copy link
Copy Markdown
Collaborator

@popescu-v popescu-v left a comment

Choose a reason for hiding this comment

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

LGTM, could be merged after #452 (comment) and #452 (comment) are taken into account.

@tramora tramora force-pushed the 440-document-possible-variable-types branch from 5344e67 to 0e98c12 Compare September 4, 2025 08:57
@tramora tramora merged commit dfdaf34 into dev Sep 4, 2025
19 checks passed
@tramora tramora deleted the 440-document-possible-variable-types branch September 4, 2025 10:02
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.

Improve Python documentation for variable types in the Variable class

2 participants