Skip to content

docs: add Google-style docs to diracx-cli and remove D100-D300 from per-file-ignores for it - #1033

Draft
martynia wants to merge 5 commits into
DIRACGrid:mainfrom
martynia:janusz_rest2_googledocs_diracx-cli_1004
Draft

martynia wants to merge 5 commits into
DIRACGrid:mainfrom
martynia:janusz_rest2_googledocs_diracx-cli_1004

Conversation

@martynia

@martynia martynia commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

This is a docstring fix PR for diracx-cli directory using a branched-off code from #1008.

The following changes and a verification procedure was performed:

  1. modify pyproject.toml by removing "ignores" from the relevant line: "diracx-cli/src/diracx/cli/**/*.py" = []
  2. verify failures: pixi run -e pre-commit pre-commit run ruff-check --files $(find diracx-cli -name '*.py')
  3. add google-style docstring to files in the directory in question one by one
  4. verify that ruff passes for a file fixed: i.e. pixi run -e pre-commit pre-commit run ruff-check --files $(find diracx-cli -name 'utils.py')
  5. when finished with all files verify that all files pass:pixi run -e pre-commit pre-commit run ruff-check --files $(find diracx-cli -name '*.py')

@martynia martynia changed the title docs: Add Google-style docs to diracx-cli and remove D100-D300 from per-file-ignores for it docs: add Google-style docs to diracx-cli and remove D100-D300 from per-file-ignores for it Sep 7, 2026
@martynia
martynia requested a review from aldbr September 7, 2026 12:05
Comment thread diracx-cli/src/diracx/cli/internal/config.py Outdated
Comment thread diracx-cli/src/diracx/cli/internal/config.py Outdated
Comment thread diracx-cli/src/diracx/cli/internal/config.py Outdated
Comment thread diracx-cli/src/diracx/cli/internal/config.py Outdated
Comment thread diracx-cli/src/diracx/cli/internal/config.py Outdated
Comment thread diracx-cli/src/diracx/cli/jobs.py Outdated
Comment thread diracx-cli/src/diracx/cli/jobs.py Outdated
Comment thread diracx-cli/src/diracx/cli/jobs.py Outdated
Comment thread diracx-cli/src/diracx/cli/auth.py Outdated
Comment thread diracx-cli/src/diracx/cli/jobs.py Outdated
@DIRACGridBot
DIRACGridBot marked this pull request as draft September 8, 2026 14:39
@martynia
martynia force-pushed the janusz_rest2_googledocs_diracx-cli_1004 branch from fc001f6 to 12b78b3 Compare September 8, 2026 15:53
Adress comments from a review

Co-authored-by: DevLink42 <42943261+devlink42@users.noreply.github.com>
@martynia
martynia force-pushed the janusz_rest2_googledocs_diracx-cli_1004 branch from 12b78b3 to 7d38415 Compare September 9, 2026 06:32
@martynia
martynia requested a review from devlink42 September 9, 2026 07:13
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 diracx | 🛠️ Build #34469048 | 📁 Comparing 6e5c051 against latest (49207d1)

  🔍 Preview build  

2 files changed
± admin/explanations/architecture_diagram/index.html
± admin/explanations/chart-structure/index.html

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