search

emencia / diskette

💾 Export and import Django application data and medias
https://diskette.readthedocs.io/
MIT License
1 stars 0 forks source link

Settings documentation exposes local path #16

Open sveetch opened 1 month ago

sveetch commented 1 month ago

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:

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 commented 1 week ago

We could just set them to None in default settings and code using them should do the Path.cwd() themselves when it is None (and it is possibly be already done somewhere). These setttings doc should mention it would be resolved to 'cwd' when null.