Fix new needs weak content not detected#214
Conversation
Aymen-Soussi-01
requested review from
AlexanderLanin,
MaximilianSoerenPollak and
dcalavrezo-qorix
as code owners
License Check Results🚀 The license check job ran with the Bazel command: bazel run //src:license-checkStatus: Click to expand output |
|
|
||
| Docs-as-Code shall enforce that requirement descriptions do not contain the following weak words: | ||
| just, about, really, some, thing, absol-utely | ||
| just, about, really, some, thing, absolutely |
There was a problem hiding this comment.
These ones should not create an error.
there fore these might need to be moved to a 'note' or somethign.
Otherwise we will always error here, no?
There was a problem hiding this comment.
This will not make an error, it's just to correct the requirement spelling, that's all
There was a problem hiding this comment.
Try if this fixes it:
.. tool_req:: Enforces description wording rules
:id: tool_req__docs_common_attr_desc_wording
:tags: Common Attributes
:implemented: YES
:satisfies:
PROCESS_gd_req__req_desc_weak,
:parent_covered: YES
Docs-as-Code shall enforce that requirement descriptions do not contain the weak words mentioned below
This rule applies to:
* all requirement types defined in :need:`tool_req__docs_req_types`, except process requirements.
.. note::
Weak words mentioned here to avoid warning.
=> just, about, really, some, thing, absolutely
There was a problem hiding this comment.
Fixed by adding "-" to every weak word and leave the old note: Artificial...
| CollectResult = tuple[ | ||
| str, # structure_text | ||
| str, # link_text | ||
| dict[str, str], # proc_impl_interfaces | ||
| dict[str, list[str]], # proc_used_interfaces | ||
| dict[str, str], # impl_comp | ||
| list[str], # proc_modules | ||
| ] |
There was a problem hiding this comment.
This change is quiet random in this PR, has not much to do with the issue you're trying to solve.
Don't mix in random changes please (even if they are valid).
There was a problem hiding this comment.
As requested from PR: #211, I did the required fixes for the remaining comments
It's the comment related to creating a type for the return value of the function, as it is complex
There was a problem hiding this comment.
Ye, but that should not be in this PR. As it's not related with the fix / issue you are fixing here.
| This should really work | ||
|
|
||
|
|
||
| #EXPECT: contains a weak word: |
There was a problem hiding this comment.
Does this even work, is this not too vague?
There was a problem hiding this comment.
Fixed. Please resolve.
| target_id="tool_req__002", | ||
| id="tool_req__002", | ||
| type="tool_req", | ||
| some_required_option=["not_a_string", 123], |
There was a problem hiding this comment.
This doesn't work either no?
There was a problem hiding this comment.
Since we are converting the values inside the list to strings? No? Not sure though, please enlighten me here.
There was a problem hiding this comment.
I just changed to a simple case where the some_required_option takes a number as a value, and the test is passing. Please resolve.
|
The created documentation from the pull request is available at: docu-html |
Aymen-Soussi-01
force-pushed
the
fix-new-needs-weak-content-not-detected
branch
from
80f672c to
be7154d
Compare
MaximilianSoerenPollak
merged commit 0d7f37b
into
eclipse-score:main
github-project-automation
Bot
moved this from Draft
to Done
in INF - Infrastructure Community
* Fix and simplify complexity for weak content check * handle edge cases to remove matching between "something" and "thing" * Correct PR eclipse-score#211 remaining comments
2 participants
close: #196