Skip to content

Add user-facing documentation #27

@sethaxen

Description

@sethaxen

Currently the documentation only explains how developers should use the package, but users also need to know how to use it to update preferences. It took me some troubleshooting to figure it out. I think it needs to document the following 2 ways:

  1. set_preferences!: this requires the user launch a new Julia session if developers implemented preferences with a const like in the ReadMe.
  2. add an entry to LocalPreferences.toml in the user's environment

It should note that neither of these work with temporary environments, since relaunching loses the environment.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions