Skip to content

docs: add Google-style docs to diracx-logic and remove D100-D300 from per-file-ignores for it (#1076) - #1167

Merged
aldbr merged 5 commits into
DIRACGrid:mainfrom
martynia:janusz_rest2_googledocs_diracx-logic_1004
Nov 5, 2026
Merged

aldbr merged 5 commits into
DIRACGrid:mainfrom
martynia:janusz_rest2_googledocs_diracx-logic_1004

Conversation

@martynia

@martynia martynia commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Add google style comments to dirac-logic (#1076)

@read-the-docs-community

read-the-docs-community Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 diracx | 🛠️ Build #35675933 | 📁 Comparing 443beb7 against latest (8ea2d18)

  🔍 Preview build  

3 files changed
+ overrides/home.html
± index.html
- assets/home.html

@martynia
martynia force-pushed the janusz_rest2_googledocs_diracx-logic_1004 branch from 577b2d4 to a48ebb8 Compare November 5, 2026 10:24
@martynia
martynia marked this pull request as ready for review November 5, 2026 13:40
@martynia
martynia requested a review from aldbr November 5, 2026 13:40
aldbr added 2 commits November 5, 2026 16:19
Logic docstrings now describe behaviour and domain exceptions; the HTTP
contract (status codes, headers, admin policy) stays in diracx-routers.

- Fix statements that did not match the code: heartbeat data goes to
  HeartBeatLoggingInfo, calculate_priority mutates all_tqs_data, a scope
  needs exactly one VO, and the unreachable NotImplementedError is gone.
- Complete Raises sections for the token, flow and submission functions.
- Remove paragraphs copied from router docstrings and mentions of router
  behaviour (admin bypass, token enrichment, ETag/Vary).
- Restore the transformations package docstring (D104 is ignored).

Assisted-by: Claude:claude-opus-5-5
An empty ignore list behaves the same as having no entry, and no other
glob in the table matches these source trees, so D100-D103 keep applying
to diracx-db, diracx-cli, diracx-core and diracx-logic.

Assisted-by: Claude:claude-opus-5-5
@aldbr
aldbr enabled auto-merge (squash) November 5, 2026 16:33
@aldbr
aldbr merged commit 7d49fa9 into DIRACGrid:main Nov 5, 2026
35 checks passed
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