Skip to content

docs: modify rest style comments with doc convert to follow google style.#993

Open
martynia wants to merge 2 commits into
DIRACGrid:mainfrom
martynia:janusz_rest2_googledocs_927
Open

docs: modify rest style comments with doc convert to follow google style.#993
martynia wants to merge 2 commits into
DIRACGrid:mainfrom
martynia:janusz_rest2_googledocs_927

Conversation

@martynia

@martynia martynia commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

A minimal change, only convert rest style comments to google style comments. Don't modify comments themselves, when possible. Fixes #927

@aldbr
aldbr requested a review from devlink42 July 16, 2026 08:08
Comment thread diracx-db/src/diracx/db/sql/auth/db.py Outdated
Comment thread diracx-db/src/diracx/db/sql/auth/db.py Outdated
Comment thread diracx-db/src/diracx/db/sql/job/db.py
Comment thread diracx-logic/src/diracx/logic/jobs/status.py Outdated
Comment thread diracx-logic/src/diracx/logic/auth/utils.py Outdated
Comment on lines -85 to -86
:raises: diracx.core.exceptions.NotReadyError if the source is being loaded still
:raises: git.exc.BadName if version does not exist

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.

Raises have been deleted, is that expected?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I don't think so because there is no explicit 'raise' in the core of the function, so we don't normally have to put it in, do we?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think @devlink42 is right here.

Comment on lines -96 to -97
:raises: diracx.core.exceptions.NotReadyError if the source is being loaded still
:raises: git.exc.BadName if version does not exist

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.

Same here, they have been deleted

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

No explicit rase.

@DIRACGridBot
DIRACGridBot marked this pull request as draft July 17, 2026 08:50
@martynia

martynia commented Jul 17, 2026 via email

Copy link
Copy Markdown
Contributor Author

@martynia
martynia marked this pull request as ready for review July 21, 2026 14:11
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.

Enhancement: Harmonize Docstring convention to Google Style (Native MkDocs Support & CI Enforcement)

3 participants