Repository navigation
Modernize - phase 6 - docstrings - #108
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates documentation across the bbconf Python package to use Google-style docstrings as part of the “Modernize - phase 4” effort, plus a small Pydantic default fix and a new CI lint/format workflow.
Changes:
- Converted many docstrings from reST-style
:param/:return:to Google-styleArgs/Returns. - Fixed
StandardMeta.global_*_iddefaults toNone(instead of an incorrect empty-string default). - Added a GitHub Actions workflow to run
ruff checkandruff format --check.
Reviewed changes
Copilot reviewed 11 out of 12 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| bbconf/modules/objects.py | Google-style docstrings for object URI/DRS helpers. |
| bbconf/modules/bedsets.py | Google-style docstrings for bedset operations. |
| bbconf/modules/bedfiles.py | Google-style docstrings for bedfile operations; minor doc wording tweaks. |
| bbconf/models/bed_models.py | Fixes StandardMeta defaults for global_sample_id/global_experiment_id. |
| bbconf/helpers.py | Google-style docstrings for config/path helpers. |
| bbconf/exceptions.py | Reformats exception class docstrings. |
| bbconf/db_utils.py | Updates docstrings/strings in DB utilities. |
| bbconf/config_parser/utils.py | Google-style docstring for config analyzer. |
| bbconf/config_parser/models.py | Docstring updates for config model helpers. |
| bbconf/config_parser/bedbaseconfig.py | Docstring updates for config initialization helpers. |
| bbconf/bbagent.py | Docstring updates for main agent API. |
| .github/workflows/format.yml | Adds CI job to enforce Ruff linting and formatting. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Changes:
:param/:return:to Google-styleArgs/Returns.TODO:
__version__.pyfile