Add Requested Docs Changes From #369 #456
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
This commit adds the requested docs changes from PR WEC-Sim#369. Specific changes are: * Adding outputs of WEC-Sim to the introduction (index.rst) * Added info about OOP in the Overview section * Improved the mass tables in the tutorials
8 tasks
akeeste
requested changes
Dec 7, 2020
Contributor
akeeste
left a comment
There was a problem hiding this comment.
These changes look good. I commented on a couple minor things that I think will make it read better
Comment on lines
+64
to
+68
| directory. WEC-Sim uses `object orientated programming | ||
| <https://uk.mathworks.com/discovery/object-oriented-programming.html>`__ to | ||
| describe components of the WEC model; the main structure of the input file | ||
| consists of initializing all the objects necessary to run WEC-Sim simulations | ||
| and defining any user specified properties for each object. |
Contributor
There was a problem hiding this comment.
Good! I think this is more clear and gives a new user a better idea of what to expect when using WEC-Sim
kmruehl
reviewed
Dec 16, 2020
Comment on lines
+64
to
+68
| directory. WEC-Sim uses `object orientated programming | ||
| <https://uk.mathworks.com/discovery/object-oriented-programming.html>`__ to | ||
| describe components of the WEC model; the main structure of the input file | ||
| consists of initializing all the objects necessary to run WEC-Sim simulations | ||
| and defining any user specified properties for each object. |
Contributor
Author
akeeste
approved these changes
Dec 17, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This commit adds the requested docs changes from PR #369. Specific changes are: