MAINT: docs maintenance (WIP) #740
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
2 tasks
|
I don't know what it is happening with the error with NumPy v2. The testing with NumPy v2 was introduced by #736. Something may be wrong in there... |
|
The error should be resolved by #743. |
|
thanks @oyamad |
oyamad
reviewed
Nov 27, 2024
docs/source/contributing.rst
Outdated
| ------------------- | ||
|
|
||
| We try to maintain a simple and consistent format for inline documentation, known in the Python world as docstrings. | ||
| The format we use is known as :ref:`numpydoc<https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`. |
There was a problem hiding this comment.
thanks @oyamad migrating content at the moment from the QuantEcon org site and will proof read. Appreciate the comment.
|
@mmcky Could you add an instruction about how to install with |
|
Hello @mmcky! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:
Comment last updated at 2024-11-27 04:33:18 UTC |
|
thanks @oyamad once this passes green I think we can merge. |
oyamad
reviewed
Nov 27, 2024
Co-authored-by: Daisuke Oyama <[email protected]>
Co-authored-by: Daisuke Oyama <[email protected]>
|
thanks for reviewing @oyamad -- merged all suggestions. |
oyamad
approved these changes
Nov 27, 2024
|
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
rtdsome of this information is migrated from organization website