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

Write list of available options #35

Open
swertz opened this issue Dec 26, 2015 · 3 comments
Open

Write list of available options #35

swertz opened this issue Dec 26, 2015 · 3 comments

Comments

@swertz
Copy link

swertz commented Dec 26, 2015

I've started a list of all the options that can be used in the configuration files, since with all the PRs it's becoming difficult to keep updated: https://github.com/cp3-llbb/plotIt/wiki/List-of-configuration-options

Do not hesitate to fill in what's missing! For some options I couldn't find immediately where they were used in the code (github's search in the code does not work for forked repos, and this repo is becoming quite different from Seb's original one)... Default values are defined in 3-4 different places, so I might have missed some. It's also not always quite clear whether a field is required or not.

Unfortunately the table does not render very well on the github wiki..

@blinkseb
Copy link
Member

That's awesome thanks!

I've started to complete a bit the wiki page. I've also, as you already saw, tried to move all default values to the structures declaration so it's easier to see those values.

@pieterdavid
Copy link
Member

The documentation is now at http://cp3-llbb.github.io/plotit/ (I copied the contents there, and made the wiki home page point to it; the tables do look a bit better there; travis is set up for deployment, so editing can even be done with the web editor).
Are there known things missing, i.e. shall we close this, or better keep it open as a reminder to keep the docs up to date and improve them where needed?

@swertz
Copy link
Author

swertz commented Oct 30, 2019

There are still things missing in the documentation so we can keep it open as a reminder!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants