Add error message guidelines and how to build a PDF locally #45
Conversation
This file contains hidden or 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
…mation on building a PDF of the documentation locally on Windows
PipKat
changed the title
PipKat
changed the title
akaszynski
reviewed
Feb 10, 2022
Comment on lines
111
to
113
| When writing error messages, follow the `Error Message Guidelines | ||
| <https://docs.microsoft.com/en-us/windows/win32/debug/error-message-guidelines>`_ | ||
| on the Microsoft website to ensure that your messages are well crafted. |
There was a problem hiding this comment.
I'm fine with these recommendations, is there potentially a more "Pythonic" style guide for error messages?
There was a problem hiding this comment.
@akaszynski I've added two but you should probably check to see that they are good examples.
akaszynski
reviewed
Feb 10, 2022
akaszynski
reviewed
Feb 10, 2022
akaszynski
reviewed
Feb 10, 2022
akaszynski
reviewed
Feb 10, 2022
akaszynski
reviewed
Feb 10, 2022
akaszynski
approved these changes
Feb 10, 2022
MaxJPRey
reviewed
Feb 10, 2022
MaxJPRey
approved these changes
Feb 10, 2022
Add Linux PDF build link Co-authored-by: Alex Kaszynski <[email protected]>
PipKat
commented
Feb 10, 2022
PipKat
commented
Feb 10, 2022
PipKat
commented
Feb 10, 2022
…s://github.com/pyansys/dev-guide into doc/add_error_message_and_building_pdf_locally # Conflicts: # doc/source/guidelines/doc_practices.rst
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.
No description provided.