Skip to content

add override capabilities to repeated capabilities documentation - #2183

Open
elebel-emerson wants to merge 6 commits into
ni:masterfrom
elebel-emerson:updateRepeatedCaps
Open

add override capabilities to repeated capabilities documentation#2183
elebel-emerson wants to merge 6 commits into
ni:masterfrom
elebel-emerson:updateRepeatedCaps

Conversation

@elebel-emerson

@elebel-emersonelebel-emerson commented Jul 2, 2026

Copy link
Copy Markdown

- [ ] 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

codecov-commenter commented Jul 2, 2026

Copy link
Copy Markdown

Codecov Report

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

❗ There is a different number of reports uploaded between BASE (ab52ec6) and HEAD (9cd7344). Click for more details.

HEAD has 17 uploads less than BASE
FlagBASE (ab52ec6)HEAD (9cd7344)
codegenunittests10
nifakeunittests54
nidcpowerunittests54
nidigitalunittests54
nimodinstunittests54
niscopeunittests54
nitclkunittests54
nimodinstsystemtests10
niscopesystemtests10
niswitchsystemtests10
nirfsgsystemtests10
nidigitalsystemtests10
nisesystemtests10
nifgensystemtests10
nidmmsystemtests10
nidcpowersystemtests10
nitclksystemtests10
Additional details and impacted files

Impacted file tree graph

@@ Coverage Diff @@## master #2183 +/- ##
==========================================
- Coverage 89.85% 80.24% -9.62% 
==========================================
Files 73 19 -54 Lines 19006 2500 -16506 ==========================================
- Hits 17077 2006 -15071 + Misses 1929 494 -1435 
FlagCoverage Δ
codegenunittests?
nidcpowersystemtests?
nidcpowerunittests89.53% <ø> (ø)
nidigitalsystemtests?
nidigitalunittests68.44% <ø> (ø)
nidmmsystemtests?
nifakeunittests86.01% <ø> (ø)
nifgensystemtests?
nimodinstsystemtests?
nimodinstunittests94.20% <ø> (ø)
nirfsgsystemtests?
niscopesystemtests?
niscopeunittests43.20% <ø> (ø)
nisesystemtests?
niswitchsystemtests?
nitclksystemtests?
nitclkunittests98.26% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.
see 58 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...9cd7344. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Copy link
Copy Markdown
Collaborator

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

@ni-jfitzger

Copy link
Copy Markdown
Collaborator

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

elebel-emerson commented Jul 22, 2026

Copy link
Copy Markdown
Author

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

Comment threadbuild/templates/rep_caps.rst.mako Outdated
@elebel-emerson
elebel-emerson marked this pull request as draft July 30, 2026 19:08
@elebel-emerson
elebel-emerson marked this pull request as ready for review July 30, 2026 19:38
@elebel-emerson

Copy link
Copy Markdown
Author

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

Copy link
Copy Markdown
Collaborator

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

Copy link
Copy Markdown
Member

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

@marcoskirsch

Copy link
Copy Markdown
Member

You are missing a NI-FAKE example

Comment threadbuild/templates/rep_caps.rst.mako Outdated
@elebel-emersonelebel-emerson changed the title add overwrite to repeated capabilitiesadd override capabilities to repeated capabilities documentationAug 6, 2026
@elebel-emerson

Copy link
Copy Markdown
Author

"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

Copy link
Copy Markdown
Collaborator

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

Sign up for freeto 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.

4 participants

@elebel-emerson@codecov-commenter@ni-jfitzger@marcoskirsch