OCPERT-56. OAR Fix wrong data types in docstring #462
Conversation
openshift-merge-robot
added
the
needs-rebase
|
PR needs rebase. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@ltroiano-rh: The following tests failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
There was a problem hiding this comment.
Hello @ltroiano-rh ,
There is redundant "." in your commit message.
Please rebase your pull-request with master.
Thank you!
| @@ -31,7 +31,7 @@ def get_advisories(self): | |||
| Get all advisories | |||
| Returns: | |||
| []Advisory: all advisory wrappers | |||
| List[Advisory] : all advisory wrappers | |||
There was a problem hiding this comment.
The method returns a different type.
| @@ -51,7 +51,7 @@ def get_jira_issues(self): | |||
| Get all jira issues from advisories in a release | |||
| Returns: | |||
| []: all jira issues from advisories | |||
| List: all jira issues from advisories | |||
There was a problem hiding this comment.
The method returns a different type.
| @@ -199,7 +199,7 @@ def drop_bugs(self): | |||
| AdvisoryException: error when dropping bugs from advisory | |||
| Returns: | |||
| []: bugs cannot be dropped | |||
| Tuple [list, list]: bugst to be dropped, bugs cannot be dropped | |||
There was a problem hiding this comment.
The syntax is valid, but we should keep the types consistent across files. It's a good practice to use standard types.
The method returns a different type.
There was a problem hiding this comment.
There is also a typo at this line.
| @@ -252,7 +252,7 @@ def check_cve_tracker_bug(self): | |||
| AdvisoryException: error when invoke elliott cmd | |||
| Returns: | |||
| json: missed CVE tracker bugs | |||
| List[str]: missed CVE tracker bugs | |||
There was a problem hiding this comment.
The method returns a different type.
| Returns: | ||
| []JiraIssue: jira subtask list | ||
| List [JiraIssue]: jira subtask list |
There was a problem hiding this comment.
The syntax is valid, but we should keep the types consistent across files. It's a good practice to use standard types.
The method returns a different type.
|
@ltroiano-rh one more note, to avoid having the same commit message in git history, use a different commit message. Please keep the jira id in it. |
|
This PR follows up #454 |
OAR Fix wrong data types in docstring in https://github.com/openshift/release-tests repository.
Details:
OAR tool docstring use wrong data types in docstring. For example [] instead of list.
Update all docstrings in OAR tool to use correct OAR types.
Scope:
OAR tool only.
It is not a goal to provide new docstrings, or add types to actual code.