Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

some help text updates and a test to check for discrepancies in help text #117

Merged
merged 13 commits into from
Oct 24, 2018
Merged

some help text updates and a test to check for discrepancies in help text #117

merged 13 commits into from
Oct 24, 2018

Conversation

Christina-Kang
Copy link
Contributor

Changes include:

  • Add a test to check if custom help text is the same as swagger help text
  • Some changes based on findings of the script. These changes are not comprehensive, and will be updated more in the future. Set test to allow the current number of mismatches.

Verifed:

  • Build and test CI passes
  • History and readme updated to reflect changes
  • Package version updated according to semantic versioning rules
  • Tests modified or added, when applicable
  • Updated code owners file, when applicable
  • Read the PR checklist

@Christina-Kang
Copy link
Contributor Author

@samedder I will update this script a bit once the knack people make the change to being able to retrieve the help text. They mentioned before it should be some time this summer.

jeffj6123
jeffj6123 previously approved these changes Oct 9, 2018
View reviewed changes
@Christina-Kang Christina-Kang changed the title some help text updates and a script to check for discrepancies some help text updates and a test to check for discrepancies in help text Oct 9, 2018
jeffj6123
jeffj6123 reviewed Oct 16, 2018
View reviewed changes
src/sfctl/tests/custom_help_text_correctness_test.py

# If a line from a customs helps file starts with the following, do not validate.
# This list should eventually become empty
exclusion_list = [
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How would this list eventually get smaller?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added more detailed explanation in comments in the file.

jeffj6123
jeffj6123 previously approved these changes Oct 16, 2018
View reviewed changes
@Christina-Kang
Update custom_help_text_correctness_test.py
4c151b6 
Add more details to comments.
@coveralls
Copy link

coveralls commented Oct 17, 2018 •
edited

Coverage Status

Coverage increased (+0.5%) to 86.32% when pulling e410d01 on Christina-Kang:custom_help_text_check into 05c97a3 on Microsoft:master.

jeffj6123
jeffj6123 previously approved these changes Oct 23, 2018
View reviewed changes
@Christina-Kang
Merge branch 'master' into custom_help_text_check
90c1386
@Christina-Kang
Update custom_help_text_correctness_test.py
e410d01 
increase number of allowed help text mismatches for new mesh commands which were merged in
@Christina-Kang Christina-Kang merged commit 778fd25 into microsoft:master Oct 24, 2018
@Christina-Kang Christina-Kang deleted the custom_help_text_check branch October 24, 2018 01:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeffj6123 jeffj6123 jeffj6123 left review comments

@samedder samedder Awaiting requested review from samedder samedder is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@Christina-Kang @coveralls @jeffj6123