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

Improve documentation of formatting options. #299

Closed
4 of 6 tasks
hhugo opened this issue Aug 9, 2018 · 3 comments
Closed
4 of 6 tasks

Improve documentation of formatting options. #299

hhugo opened this issue Aug 9, 2018 · 3 comments

Comments

@hhugo
Copy link
Collaborator

hhugo commented Aug 9, 2018

  • factorize the documentation of options regarding the syntax in config files
    (e.g. Can be set in a config file with an 'wrap-fun-args = {true,false}' line.)
  • review existing options and ensure all values, and meaning of booleans, are documented
  • improve support for boolean flags, changing the default value should update the documentation
  • support short forms for inverted boolean flags, e.g. by changing capitalization
  • consider using a single env variable to configure ocamlformat
    (e.g. OCAMLFORMAT=opt1=1,opt2=2 ocamlformat)
  • divide the 'formatting' options and 'operational' options into separate sections
@gpetiot
Copy link
Collaborator

gpetiot commented Oct 8, 2018

Can we consider everything on this list is done? (if I understand correctly the 4th point is the "no-" prefix)

@jberdine
Copy link
Collaborator

jberdine commented Oct 8, 2018

I'm not sure we have reviewed all the existing options documentation, but perhaps. The point about improving the docs for boolean flags is to make the documentation change when the default value is changed, which is not done I think. For inverted short forms, the thought was to use e.g. -G for the inverted version of -g, similarly to how --no-goo is the inverted long form of --goo.

@hhugo
Copy link
Collaborator Author

hhugo commented Oct 30, 2019

We can close, #1062 is merged.

@hhugo hhugo closed this as completed Oct 30, 2019
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