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

Add user-facing documentation #27

Open
sethaxen opened this issue Jan 21, 2022 · 4 comments
Open

Add user-facing documentation #27

sethaxen opened this issue Jan 21, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@sethaxen
Copy link

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.

@vchuravy
Copy link
Member

I think the first step would be to actually setup documenter :)

@vchuravy vchuravy added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Apr 20, 2022
@claforte
Copy link

claforte commented Jun 6, 2022

In the meantime can we at least get a link to an example project that uses Preferences.jl?

@claforte
Copy link

Also the README should mention that Pkg handling preferences correctly only came into being in v1.8.0, as mentioned in Preferences/test/PTest/src/PTest do_test()...

@nsajko
Copy link

nsajko commented Jan 14, 2024

It seems there's another package that aims to provide an interface more suited to interactive use: PreferenceTools.jl.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants