add override capabilities to repeated capabilities documentation by elebel-emerson · Pull Request #2183 · ni/nimi-python

elebel-emerson · 2026-07-02T18:31:53Z

This contribution adheres to CONTRIBUTING.md.

~~- [ ] I've updated CHANGELOG.md if applicable.~~

I've added tests applicable for this pull request

What does this Pull Request accomplish?

Change generated Repeated Capabilities documentation to support metadata-defined descriptions, examples, and identifier guidance for capability-specific behavior.

What testing has been done?

Manually testing change in config.py propagates to html documentation
Create a unit test

codecov-commenter · 2026-07-02T18:45:45Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.70%. Comparing base (ab52ec6) to head (8e16ee1).
⚠️ Report is 17 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2183      +/-   ##
==========================================
- Coverage   89.85%   88.70%   -1.15%     
==========================================
  Files          73       59      -14     
  Lines       19006    18722     -284     
==========================================
- Hits        17077    16607     -470     
- Misses       1929     2115     +186

Flag	Coverage Δ
codegenunittests	`?`
nidcpowersystemtests	`94.38% <ø> (-0.23%)`	⬇️
nidcpowerunittests	`?`
nidigitalsystemtests	`92.02% <ø> (-0.24%)`	⬇️
nidigitalunittests	`?`
nidmmsystemtests	`92.29% <ø> (-0.44%)`	⬇️
nifakeunittests	`?`
nifgensystemtests	`94.32% <ø> (-0.30%)`	⬇️
nimodinstsystemtests	`73.85% <ø> (ø)`
nimodinstunittests	`?`
nirfsasystemtests	`82.66% <ø> (?)`
nirfsgsystemtests	`81.12% <ø> (ø)`
niscopesystemtests	`89.96% <ø> (-2.99%)`	⬇️
niscopeunittests	`?`
nisesystemtests	`91.50% <ø> (ø)`
niswitchsystemtests	`81.56% <ø> (-0.48%)`	⬇️
nitclksystemtests	`94.87% <ø> (ø)`
nitclkunittests	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.
see 46 files with indirect coverage changes

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ab52ec6...8e16ee1. Read the comment docs.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

ni-jfitzger · 2026-07-22T20:36:40Z

Why are you changing the file modes of our metadata files?

ni-jfitzger · 2026-07-22T20:37:58Z

Note: if you pull the latest changes, the system tests will pass.
Not really a requirement for this change, but the PR Checks would look better.

elebel-emerson · 2026-07-22T20:43:05Z

Why are you changing the file modes of our metadata files?

I did not explicitly touch those files, doing tox -e codegen touched those files, and I just committed.
Removed the changed to file mode in 92b5d19

elebel-emerson · 2026-08-05T19:28:18Z

Note: if you pull the latest changes, the system tests will pass. Not really a requirement for this change, but the PR Checks would look better.

git pull origin says I am up to date with origin. Still one failing change that does not seem correlated to this change

ni-jfitzger · 2026-08-05T19:30:26Z

Note: if you pull the latest changes, the system tests will pass. Not really a requirement for this change, but the PR Checks would look better.

git pull origin says I am up to date with origin. Still one failing change that does not seem correlated to this change

Yeah, any system test failures are unrelated to your changes. You haven't touched the API or the System Tests.

marcoskirsch · 2026-08-06T13:45:13Z

"overwrite" should be "override" (nim-python terminology)

marcoskirsch · 2026-08-06T13:45:32Z

You are missing a NI-FAKE example

elebel-emerson · 2026-08-06T21:13:47Z

"overwrite" should be "override" (nim-python terminology)

Hopefully changed all instances of "overwrite" to "override"

You are missing a NI-FAKE example

Added unit tests in test_rep_caps_template.py

ni-jfitzger · 2026-08-11T18:52:59Z

Your changes to metadata_add_all.py are causing related unit tests to fail.

elebel-emerson · 2026-08-13T20:50:24Z

Your changes to metadata_add_all.py are causing related unit tests to fail.

Should have fixed failures with Travic CI

ni-jfitzger · 2026-08-20T16:46:18Z

Why are you making a functional change?
I thought we talked about this and determined that chained rep caps already provided the necessary functionality.

elebel-emerson · 2026-08-20T20:30:10Z

Why are you making a functional change? I thought we talked about this and determined that chained rep caps already provided the necessary functionality.

Undid the functional change, everything is passing

elebel-emerson · 2026-08-24T15:24:55Z

Note: if you pull the latest changes, the system tests will pass. Not really a requirement for this change, but the PR Checks would look better.

git pull origin says I am up to date with origin. Still one failing change that does not seem correlated to this change

Yeah, any system test failures are unrelated to your changes. You haven't touched the API or the System Tests.

Pending some system_tests but everything should be up to date with main, let's hope the system tests do not fail again

ni-jfitzger · 2026-08-25T00:19:27Z

    .. py:attribute:: nifgen.Session.script_triggers[]

-        If no prefix is added to the items in the parameter, the correct prefix will be added when
+    If no prefix is added to the items in the parameter, the correct prefix will be added when


You have a rendering change here, due to the spacing change. I think it's affecting docs for other APIs, like nirfsg, too.

https://nifgen--2183.org.readthedocs.build/en/2183/rep_caps.html
https://nifgen.readthedocs.io/en/nifgen-1.5.0/rep_caps.html

Normally, you'd automatically see the link to the built documentation in the PR checks, but we're having issues, right now.

ni-jfitzger · 2026-08-25T00:24:48Z

You should pull upstream/master.
nirfsa has documentation that isn't present in your branch, so you may introducing changes to it that we can't see.

ni-jfitzger · 2026-08-25T00:26:03Z

If you see any changes in the existing rep_caps.rst, that's probably not a good sign.
The goal here is to add new support without affecting existing documentation, right?

ni-jfitzger · 2026-08-25T00:28:55Z

        {
+            'documentation': {
+                'description': 'Sites are identified by the ``site`` prefix followed by a zero-based index.',
+                'valid_indices': ['site0', 'site1'],


"site0" is not an index. It's a key.
0 is an index.

elebel-emerson added 2 commits July 2, 2026 10:42

add overwrite to repeated capabilities

bc59057

Test for rep caps template

db0726d

elebel-emerson marked this pull request as ready for review July 2, 2026 19:21

elebel-emerson requested review from marcoskirsch, ni-jfitzger and vnktshr21 as code owners July 2, 2026 19:21

codegen

dcb3894

ni-jfitzger reviewed Jul 22, 2026

View reviewed changes

Comment thread build/templates/rep_caps.rst.mako Outdated

elebel-emerson marked this pull request as draft July 30, 2026 19:08

elebel-emerson added 2 commits July 30, 2026 14:11

Revert changes to file modes

92b5d19

remove auto_prefix_addition_supported

a5b270d

elebel-emerson marked this pull request as ready for review July 30, 2026 19:38

elebel-emerson requested a review from ni-jfitzger July 30, 2026 19:38

marcoskirsch requested changes Aug 6, 2026

View reviewed changes

Comment thread build/templates/rep_caps.rst.mako Outdated

expanding metadata instead of creating

9cd7344

elebel-emerson changed the title ~~add overwrite to repeated capabilities~~ add override capabilities to repeated capabilities documentation Aug 6, 2026

elebel-emerson requested a review from marcoskirsch August 6, 2026 21:26

change repeated capabilities to pass

33883f0

elebel-emerson added 2 commits August 20, 2026 13:50

remove functional change

eae401f

testing chained rep caps

53574b6

marcoskirsch approved these changes Aug 20, 2026

View reviewed changes

Comment thread docs/nidcpower/rep_caps.rst

ni-jfitzger mentioned this pull request Aug 22, 2026

Travis-CI has stopped accepting PR Triggers #2202

Closed

fixing whitespace/code sections

4b2ab0d

ni-jfitzger reviewed Aug 24, 2026

View reviewed changes

Comment thread build/templates/rep_caps.rst.mako Outdated

Comment thread build/templates/rep_caps.rst.mako Outdated

Comment thread build/templates/rep_caps.rst.mako Outdated

Comment thread build/templates/rep_caps.rst.mako Outdated

change to use valid_indices instead of valid_identifiers

8e16ee1

ni-jfitzger reviewed Aug 25, 2026

View reviewed changes

Uh oh!

Conversation

elebel-emerson commented Jul 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this Pull Request accomplish?

What testing has been done?

Uh oh!

codecov-commenter commented Jul 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ni-jfitzger commented Jul 22, 2026

Uh oh!

ni-jfitzger commented Jul 22, 2026

Uh oh!

elebel-emerson commented Jul 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

elebel-emerson commented Aug 5, 2026

Uh oh!

ni-jfitzger commented Aug 5, 2026

Uh oh!

marcoskirsch commented Aug 6, 2026

Uh oh!

marcoskirsch commented Aug 6, 2026

Uh oh!

Uh oh!

elebel-emerson commented Aug 6, 2026

Uh oh!

ni-jfitzger commented Aug 11, 2026

Uh oh!

elebel-emerson commented Aug 13, 2026

Uh oh!

ni-jfitzger commented Aug 20, 2026

Uh oh!

elebel-emerson commented Aug 20, 2026

Uh oh!

Uh oh!

elebel-emerson commented Aug 24, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ni-jfitzger Aug 25, 2026

Choose a reason for hiding this comment

Uh oh!

ni-jfitzger commented Aug 25, 2026

Uh oh!

ni-jfitzger commented Aug 25, 2026

Uh oh!

ni-jfitzger Aug 25, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

elebel-emerson commented Jul 2, 2026 •

edited

Loading

codecov-commenter commented Jul 2, 2026 •

edited

Loading

elebel-emerson commented Jul 22, 2026 •

edited

Loading