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

Settings documentation exposes local path #16

Open
sveetch opened this issue Oct 14, 2024 · 0 comments
Open

Settings documentation exposes local path #16

sveetch opened this issue Oct 14, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@sveetch
Copy link
Member

sveetch commented Oct 14, 2024

Describe the bug

As it can be seen here: https://diskette.readthedocs.io/en/latest/settings.html#diskette.settings.DISKETTE_DUMP_PATH

Autodoc resolve the path and will display it as the default setting value, which is not very nice to do.

Environment

Describe your environment:

  • Plateform: Window/IOS/Linux distribution
  • Python version: Any
  • Diskette version: Any

Expected behavior

I don't really know yet how to solve this but a local path should not be exposed since it can trouble developers and may be a potential security concern, even it will always be about the RTD build environment.

@sveetch sveetch added the bug Something isn't working label Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant