Skip to content

Modernize - phase 6 - docstrings - #108

Merged
khoroshevskyi merged 3 commits into
modernize_1from
modernize_p6
Feb 26, 2026
Merged

khoroshevskyi merged 3 commits into
modernize_1from
modernize_p6

Conversation

@khoroshevskyi

@khoroshevskyi khoroshevskyi commented Feb 17, 2026 •

Copy link
Copy Markdown
Member

Changes:

  • Converted many docstrings from reST-style :param/:return: to Google-style Args/Returns.

TODO:

  • Version of pepdbagent updated in __version__.py file
  • Changelog updated

@khoroshevskyi khoroshevskyi changed the title Modernizing - docstrings Modernize - phase 4 - docstrings Feb 17, 2026
@khoroshevskyi khoroshevskyi changed the title Modernize - phase 4 - docstrings Modernize - phase 6 - docstrings Feb 17, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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-style Args/Returns.
  • Fixed StandardMeta.global_*_id defaults to None (instead of an incorrect empty-string default).
  • Added a GitHub Actions workflow to run ruff check and ruff 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.

Comment thread bbconf/bbagent.py
Comment thread bbconf/config_parser/utils.py
Comment thread bbconf/config_parser/bedbaseconfig.py
Comment thread bbconf/helpers.py
Comment thread bbconf/exceptions.py
Comment thread bbconf/modules/objects.py Outdated
Comment thread bbconf/db_utils.py
Comment thread bbconf/config_parser/bedbaseconfig.py
Comment thread bbconf/config_parser/bedbaseconfig.py Outdated
Comment thread bbconf/modules/bedfiles.py Outdated
@khoroshevskyi
khoroshevskyi changed the base branch from modernize_p4 to modernize_1 February 26, 2026 18:26
@khoroshevskyi
khoroshevskyi merged commit dd792f8 into modernize_1 Feb 26, 2026
2 checks passed
@khoroshevskyi
khoroshevskyi deleted the modernize_p6 branch July 31, 2026 21:35
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.

2 participants