Add the Guidelines section. #22
Merged
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
…the order from 'Overview', 'Library Overview', 'Guidelines' to 'Overview', 'Guidelines', 'Library Overview'. Move 'dev practices' section under 'Guidelines'.
MaxJPRey
commented
Dec 30, 2021
Comment on lines
+6
to
+8
| One of the main objectives of PyAnsys libraries is to wrap (encapsulate) | ||
| data and methods within units of execution while hiding data or parameters | ||
| in protected variables. |
There was a problem hiding this comment.
@akaszynski I kept this paragraph because it is quite generic. But I am not really sure it fits here.
There was a problem hiding this comment.
I think it's fine to leave this in.
akaszynski
approved these changes
Dec 30, 2021
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.
Rename 'Abstraction and Encapsulation' to 'Guidelines'.
Also, change the order from 'Overview', 'Library Overview', 'Guidelines' to 'Overview', 'Guidelines', 'Library Overview'.
Move 'development practices' section under 'Guidelines'.