documentation for test case metadata - #5744
Open
febb0e wants to merge 5 commits into
Open
Conversation
…k into docs/custom-metadata
There was a problem hiding this comment.
Pull request overview
This pull request updates Robot Framework’s documentation and model docstrings to cover “free” metadata on test cases, including documenting listener v2 attribute dictionaries containing test metadata.
Changes:
- Documented
[Metadata]as a test case setting in the user guide and settings appendix. - Documented
metadatain listener v2start_test/end_testattribute dictionaries. - Clarified model docstrings for test case metadata and the shared
Metadatamapping type.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/robot/model/testcase.py | Adds “New in Robot Framework 7.5” note to test case metadata documentation. |
| src/robot/model/metadata.py | Clarifies Metadata applies to both suite and test metadata. |
| doc/userguide/src/ExtendingRobotFramework/ListenerInterface.rst | Documents metadata in listener v2 test attribute dictionaries. |
| doc/userguide/src/CreatingTestData/CreatingTestSuites.rst | Adds a pointer from suite metadata docs to test metadata docs. |
| doc/userguide/src/CreatingTestData/CreatingTestCases.rst | Adds [Metadata] to the list of available test case settings. |
| doc/userguide/src/Appendices/AvailableSettings.rst | Adds [Metadata] to the “Test Case section” settings table. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+81
to
+82
| `[Metadata]`:setting: | ||
| Used for setting `free test metadata`_ as name-value pairs. |
Comment on lines
+221
to
+222
| Individual test cases can have similar free metadata of their own, see | ||
| `free test metadata`_ for more information. |
Comment on lines
+90
to
+91
| | [Metadata] | Used for setting `free test metadata`_. | | ||
| +-----------------+--------------------------------------------------------+ |
Comment on lines
+173
to
+174
| | | | * `metadata`: `Free test metadata`_ as a dictionary. | | ||
| | | | New in RF 7.5. | |
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request adds documentation for free metadata on test cases and updates the documentation and listener interface accordingly. The changes describe that test case metadata can be set, accessed, and is available in listener APIs, with documentation updated to show these new capabilities.
Documentation Updates:
[Metadata]setting for test cases and explain its usage, including how to specify and access free test metadata.Listener Interface:
metadatafield for test cases.