Skip to content

docs: format docstrings in utils.py#367

Open
bryzgin wants to merge 1 commit intocgre-aachen:mainfrom
bryzgin:docs/numpydoc-utils
Open

docs: format docstrings in utils.py#367
bryzgin wants to merge 1 commit intocgre-aachen:mainfrom
bryzgin:docs/numpydoc-utils

Conversation

@bryzgin
Copy link
Copy Markdown

@bryzgin bryzgin commented Mar 10, 2026

Description

This PR updates the docstrings in gemgis/utils.py to comply with the numpydoc standard, as requested in #352.

Key changes include:

  • Replaced non-standard underscores (______) with standard 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

Relates to #352

Checklist

  • My code follows the PEP 8 style guidelines.
  • My code uses type hinting for function and method arguments and return values.
  • My code contains descriptive and helpful docstrings
    which are formatted per the numpydoc Style Guidelines.
  • I have created tests which entirely cover my code.
  • The test code either 1. demonstrates at least one valuable use case (e.g. integration tests)
    or 2. verifies that outputs are as expected for given inputs (e.g. unit tests).
  • New and existing tests pass locally with my changes.

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).
Copy link
Copy Markdown

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀 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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant