Better errors and instructions #254
Merged
Conversation
This file contains 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
Incorporate feedback from Tyler's experience onboarding the cpp docs. There were some typos and outdated instructions in the README. Those are addressed. One other repeated problem is that the response from GH when there's any auth issues is (understandably) vague. Furthermore, it's valid JSON, so the code tries to parse it, fails, and reports "Key not found" errors without any context. So, wrap the config reading section in a new `try` `catch` block to report likely auth errors.
|
cc @TylerMSFT @TerryGLee as FYI |
IEvangelist
approved these changes
Aug 18, 2023
TylerMSFT
reviewed
Aug 18, 2023
TylerMSFT
reviewed
Aug 18, 2023
TylerMSFT
reviewed
Aug 18, 2023
BillWagner
added a commit
to BillWagner/docs-tools
that referenced
this pull request
Aug 18, 2023
PR dotnet#254 was merged before updating based on reviews. Adding those changes in a separate PR.
BillWagner
added a commit
to BillWagner/docs-tools
that referenced
this pull request
Aug 18, 2023
PR dotnet#254 was merged before updating based on reviews. Adding those changes in a separate PR.
BillWagner
added a commit
that referenced
this pull request
Aug 18, 2023
PR #254 was merged before updating based on reviews. Adding those changes in a separate PR.
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.
Incorporate feedback from Tyler's experience onboarding the cpp docs.
There were some typos and outdated instructions in the README. Those are addressed.
One other repeated problem is that the response from GH when there's any auth issues is (understandably) vague. Furthermore, it's valid JSON, so the code tries to parse it, fails, and reports "Key not found" errors without any context. So, wrap the config reading section in a new
trycatchblock to report likely auth errors.