Skip to content

Minor documentation issues and suggestions #444

@PhrozenByte

Description

@PhrozenByte

Some minor documentation issues and suggestions:

  • Issues
  • Suggestions
    • docs/api.rst: Unify headlines (e.g., "User data directory" for user_data_dir vs. just "Cache directory" for user_cache_dir, IMHO should be "User cache directory" et. al.)
    • docs/api.rst: Move user_runtime_dir, user_applications_dir, and user_bin_dir in front of user_documents_dir et. al. to not disrupt the shared order with the site_*_dir method list
    • docs/platforms.rst: Group the user_*_dir methods into a "User directories" section, and the site_*_dir methods into a "Shared directories" section, matching docs/api.rst; also use the same method order as docs/api.rst
    • docs/api.rst and docs/platforms.rst: Maybe add reference links to the matching section of the same method to both pages (e.g., add a link to platforms.html#user-cache-dir in the user_cache_dir section of docs/api.rst, and vice-versa)
    • docs/parameters.rst: The XDG_* env variables are explained in a section there, but not the WIN_PD_OVERRIDE_* env variables; make sure not to create too many redundancies with the existing class docs in docs/api.rst, the sections - also including the "Windows" -> "Environment variable overrides" section in docs/howto.rst - should rather reference and link to each other
    • docs/howto.rst and docs/parameters.rst: There's some redundancy between the "Linux / Unix" -> "XDG Base Directory Specification" section of docs/howto.rst, the "XDG environment variables" section of docs/parameters.rst, and the class docs in docs/api.rst; some redundancies are expected and feasible, but IMHO not to this extent; the sections should rather reference and link to each other
  • Other
    • Do the PLATFORMDIRS_* env variables actually still exist? I'm not entirely sure, but I guess not? Because they are still mentioned in docs/howto.rst, but nowhere else. If they were never actually released, they should also be removed from the changelog.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions