Skip to content

Post-processing: Add docstrings and other formatting in accordance with pylint#230

Merged
EdHone merged 4 commits intoMetOffice:mainfrom
oakleybrunt:formatting
Mar 16, 2026
Merged

Post-processing: Add docstrings and other formatting in accordance with pylint#230
EdHone merged 4 commits intoMetOffice:mainfrom
oakleybrunt:formatting

Conversation

@oakleybrunt
Copy link
Contributor

Description

This change adds docstrings in the Sphinx style, reformats Python code, and adds pylint ignore statements where reasonable.

Linked issues

Closes # (issue)

Type of change

  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • New tests have been added
  • Tests have been modified to accommodate this change

Checklist:

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes, for both debug and optimised builds

@github-actions github-actions bot added the cla-signed The CLA has been signed as part of this PR - added by GA label Mar 9, 2026
@oakleybrunt
Copy link
Contributor Author

@EdHone would you mind reviewing this? I can't request reviewers with the permissions I have.

@oakleybrunt oakleybrunt requested a review from EdHone March 13, 2026 13:08
@oakleybrunt oakleybrunt self-assigned this Mar 13, 2026
Copy link
Collaborator

@EdHone EdHone left a comment

Choose a reason for hiding this comment

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

Looks all good to me!

@EdHone EdHone merged commit a8beb82 into MetOffice:main Mar 16, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed The CLA has been signed as part of this PR - added by GA

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants