Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(auth): add scope documentation #312

Merged
merged 1 commit into from
Oct 19, 2024

Conversation

aldbr
Copy link
Contributor

@aldbr aldbr commented Oct 17, 2024

Add documentation about the scope following #300

The same string is repeated at 3 different locations in the code. While it is cumbersome (developers would need to update every instances of the doc to avoid any discrepancy, which will likely happen at some point), I don't see any other way of doing that as openapi reads the static documentation and I find it convenient to have the details when using the CLI or the openapi document.

Any opinion?

@chaen
Copy link
Contributor

chaen commented Oct 17, 2024

I think it is fine as it is. If really it is too much of an issue, you can put this in a constant, and set the __docs__ of a function to that constant. But I really don't think it's needed

@chaen chaen merged commit 6a5deb7 into DIRACGrid:main Oct 19, 2024
24 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