[docs] Elaborated on documentation for Configuration.testFilter#1638
[docs] Elaborated on documentation for Configuration.testFilter#1638truman-404 wants to merge 1 commit intoswiftlang:mainfrom
Conversation
|
Did you use an LLM or AI to write this text? |
| // MARK: - Test selection | ||
|
|
||
| /// The test filter to which tests should be filtered when run. | ||
| /// |
There was a problem hiding this comment.
Please ensure text is formatted according to our style guide and so that it is correctly rendered by the DocC compiler.
|
hey, yeah i did utilise llms to help me since i was struggling with the phrasing of the doc, I heavily apologise for it and make sure that the issue was found organically. I will push a manual written, well formatted update shortly. |
|
As The documentation for the |
|
thank you for the feedback on documentation standards, and i understand the criticality of manual oversight. I will keep it in mind for future contributions. Thanks for your time :) |
Elaborated the doc comment for 'Configuration.testFilter' to clarify the default behaviour and distinguish it from 'testCaseFilter'
Motivation:
The 'testFilter' property had a single-line doc comment whilst comparable properties in 'Configuration' have detailed documentation including notes, cross-references, and usage guidance. This makes it harder for developers to understand the default '.unfiltered' behaviour and when to use 'testFilter' vs 'testCaseFilter' for parameterised tests.
Modifications:
Checklist: