Open
Conversation
Updated docstrings in gemgis/utils.py to comply with the numpydoc standard. Key changes: - Replaced non-standard underscores (______) with dashes (------) in section headers. - Fixed parameter formatting by adding colons between names and types (name : type). - Added missing blank lines after summary descriptions to fix formatting errors. - Improved indentation and consistency in the following functions: - to_section_dict - convert_to_gempy_df - set_extent This is part of the ongoing effort to standardize documentation across the library (cgre-aachen#352).
There was a problem hiding this comment.
🚀 Thanks for opening your first pull request in GemGIS! 🚀 Please make sure you read the Contributing Guide and follow the Code of Conduct. A few things to keep in mind:
- Remember to run the tests locally to make debugging issues easier.
- If you need help writing tests, take a look at the existing ones for inspiration. If you do not know where to start, let us know and we will walk you through it.
- All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
- No matter what, we are really grateful that you put in the effort to open this PR!
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
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.
Description
This PR updates the docstrings in
gemgis/utils.pyto comply with the numpydoc standard, as requested in #352.Key changes include:
name : type).to_section_dictconvert_to_gempy_dfset_extentRelates to #352
Checklist
which are formatted per the numpydoc Style Guidelines.
or 2. verifies that outputs are as expected for given inputs (e.g. unit tests).