docs: modify rest style comments with doc convert to follow google style.#993
Draft
martynia wants to merge 1 commit into
Draft
docs: modify rest style comments with doc convert to follow google style.#993martynia wants to merge 1 commit into
martynia wants to merge 1 commit into
Conversation
devlink42
reviewed
Jul 16, 2026
|
|
||
| :raises: | ||
| Raises: | ||
| NoResultFound if no such user code currently Pending |
There was a problem hiding this comment.
Suggested change
| NoResultFound if no such user code currently Pending | |
| NoResultFound: if no such user code currently Pending |
| """Return code, redirect_uri. | ||
|
|
||
| :raises: AuthorizationError if no such uuid or status not pending. | ||
| Raises: AuthorizationError if no such uuid or status not pending. |
There was a problem hiding this comment.
Suggested change
| Raises: AuthorizationError if no such uuid or status not pending. | |
| Raises: | |
| AuthorizationError: if no such uuid or status not pending. |
Comment on lines
+207
to
209
| Returns: | ||
| rowcount | ||
|
|
There was a problem hiding this comment.
Suggested change
| Returns: | |
| rowcount | |
| Returns: | |
| rowcount |
|
|
||
| :raises: JobNotFound if the job is not found in one of the DBs | ||
| Raises: | ||
| JobNotFound if the job is not found in one of the DBs |
There was a problem hiding this comment.
Suggested change
| JobNotFound if the job is not found in one of the DBs | |
| JobNotFound if the job is not found in one of the DBs |
|
|
||
| :raises: | ||
| Raises: | ||
| * ValueError in case the scope isn't valid |
There was a problem hiding this comment.
Suggested change
| * ValueError in case the scope isn't valid | |
| ValueError in case the scope isn't valid |
aldbr
requested changes
Jul 17, 2026
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 |
Contributor
There was a problem hiding this comment.
Raises have been deleted, is that expected?
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 |
Contributor
There was a problem hiding this comment.
Same here, they have been deleted
DIRACGridBot
marked this pull request as draft
July 17, 2026 08:50
Contributor
Author
|
The converter is not perfect. I spotted a few deletions, I missed those
apparently.
…On Fri, 17 Jul 2026 at 10:50, aldbr ***@***.***> wrote:
***@***.**** requested changes on this pull request.
------------------------------
In diracx-core/src/diracx/core/sources.py
<#993 (comment)>:
> - :raises: diracx.core.exceptions.NotReadyError if the source is being loaded still
- :raises: git.exc.BadName if version does not exist
Raises have been deleted, is that expected?
------------------------------
In diracx-core/src/diracx/core/sources.py
<#993 (comment)>:
> - :raises: diracx.core.exceptions.NotReadyError if the source is being loaded still
- :raises: git.exc.BadName if version does not exist
Same here, they have been deleted
—
Reply to this email directly, view it on GitHub
<#993?email_source=notifications&email_token=AB2KE7IJJXI6ABILNO5NOG35FHSDXA5CNFSNUABKM5UWIORPF5TWS5BNNB2WEL2QOVWGYUTFOF2WK43UKJSXM2LFO4XTINZSGA4TIMJWHA42M4TFMFZW63VGMF2XI2DPOKSWK5TFNZ2KYZTPN52GK4S7MNWGSY3L#pullrequestreview-4720941689>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AB2KE7KDRB7DFYB4LBTRUS35FHSDXAVCNFSNUABFKJSXA33TNF2G64TZHM3DKNBQGU4DCOBZHNEXG43VMU5TIOBZHE4DKOJTHEY2C5QC>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
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
3 participants
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.
A minimal change, only convert rest style comments to google style comments. Don't modify comments themselves, when possible. Fixes #927