Add best practices info to sphinx docs #1048
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
bryevdv
added
category:improvement
|
I'd recommend building docs locally and inspecting the results directly, but here are a few representative screenshots
|
manopapad
approved these changes
Sep 21, 2023
| General Recommendations | ||
| ----------------------- | ||
|
|
||
| Following the basics of numpy as documented here is highly recommended. Here, |
There was a problem hiding this comment.
Suggested change
| Following the basics of numpy as documented here is highly recommended. Here, | |
| Following the basics of numpy as documented [here](https://numpy.org/doc/stable/user/basics.html) is highly recommended. Here, |
bryevdv
commented
Sep 21, 2023
Co-authored-by: Manolis Papadakis <[email protected]>
shriram-jagan
approved these changes
Sep 21, 2023
|
|
||
|
|
||
| In the example below, the function ``transform`` is defined to operate on | ||
| calars. But it can also be used on an array to linearly transform its elements, |
There was a problem hiding this comment.
typo: this should be scalars and not calars
|
|
||
| When the array needs to be updated from another array based on a condition | ||
| that they both satisfy, use ``putmask`` for better performance. Unlike the | ||
| previous example, here x is set to twice the value of y when the condition |
There was a problem hiding this comment.
nit: should we say x instead of x and similarly for y?
| x[np.logical_and(first_cond, second_cond)] = const | ||
|
|
||
|
|
||
| Refer to the documentation for other logical operations. |
There was a problem hiding this comment.
should we link documentation to this?
https://numpy.org/doc/stable/reference/routines.logic.html#logical-operations
bryevdv
commented
Sep 21, 2023
bryevdv
commented
Sep 21, 2023
bryevdv
commented
Sep 21, 2023
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.
This PR adds the "Best Practices" doc authored by @shriram-jagan to the deployed docs User Guide.