Skip to content

docs: clarify duplicate batch update ids - #1699

Open
appleweiping wants to merge 2 commits into
PowerGridModel:mainfrom
appleweiping:upgrade/data-validator-duplicate-id-docs-20261116
Open

appleweiping wants to merge 2 commits into
PowerGridModel:mainfrom
appleweiping:upgrade/data-validator-duplicate-id-docs-20261116

Conversation

@appleweiping

Copy link
Copy Markdown
Contributor

Summary

  • correct the data-validator documentation typo
  • document the current duplicate update-ID behavior and link the tracked upstream issues
  • add a documentation regression test so the warning and issue references remain present

Validation

  • focused documentation test: 1 passed
  • Ruff: passed
  • CommonMark parse: passed with one existing fence warning
  • git diff --check: passed

This PR documents the current validator boundary. It does not claim to change C++ validator behavior. The underlying behavior remains tied to the upstream validator migration tracked in issue #1552.

Signed-off-by: appleweiping <vipinapple986@gmail.com>
Signed-off-by: appleweiping <vipinapple986@gmail.com>
@figueroa1395

Copy link
Copy Markdown
Member

Hello @appleweiping,

Thank you for your contribution. However, we are currently working on migrating the python validator to the C++ core (issue #1421). At the moment, the progress can be tracked by following #1639 (done) and #1685 (in progress). That said, we don't know yet if and how #1552 would be addressed. For this reason, I think the relevant documentation should wait a little bit until the new validator logic is in a more advanced state.

Nevertheless, the typos you found can already be addressed. If you want, you can scope this PR down to addressing such small typos, and the relevant logic documentation can be deferred until a later stage.

This branch has not been deployed

No deployments
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.

2 participants