Skip to content

Deprecate the Core helper build_multi_table_dictionary_domain#395

Merged
popescu-v merged 1 commit into
dev-v10from
386-khiopscorehelpersbuild_multi_table_dictionary_domain-does-not-behave-as-expected
Apr 15, 2025
Merged

Deprecate the Core helper build_multi_table_dictionary_domain#395
popescu-v merged 1 commit into
dev-v10from
386-khiopscorehelpersbuild_multi_table_dictionary_domain-does-not-behave-as-expected

Conversation

@popescu-v
Copy link
Copy Markdown
Collaborator

@popescu-v popescu-v commented Apr 14, 2025

Keep the same functionality as a "private" function. Deprecate the usage of the public function. It could be dropped in V11.

Also add documentation note to the public function, as to its intent and purpose.

closes #386


TODO Before Asking for a Review

  • Rebase your branch to the latest version of dev-v10 (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 self-assigned this Apr 14, 2025
@popescu-v popescu-v force-pushed the 386-khiopscorehelpersbuild_multi_table_dictionary_domain-does-not-behave-as-expected branch 3 times, most recently from 80339d4 to 038867a Compare April 14, 2025 16:40
Keep the same functionality as a "private" function.
Deprecate the usage of the public function. It could be dropped in V11.

Also add documentation note to the public function, as to its intent and
purpose.

closes #386
@popescu-v popescu-v force-pushed the 386-khiopscorehelpersbuild_multi_table_dictionary_domain-does-not-behave-as-expected branch from 038867a to d2c2481 Compare April 14, 2025 16:46
@tramora
Copy link
Copy Markdown
Collaborator

tramora commented Apr 14, 2025

Indeed after reading the test function test_build_multi_table_dictionary_domain_deprecation and the added docstring we can understand that the tested function creates a root table referencing the initial table

@popescu-v popescu-v merged commit c942f3f into dev-v10 Apr 15, 2025
@popescu-v popescu-v deleted the 386-khiopscorehelpersbuild_multi_table_dictionary_domain-does-not-behave-as-expected branch April 15, 2025 09:24
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