Project documentation & deliverables
uohzxela opened this issue · 4 comments
uohzxela commented
Deliverables:
- ExDoc
- README
- Mix task
- Escript
Documentation:
-
format/1
-
mix format
whatyouhide commented
I would:
- Make
format_string/1
be the only function exposed (fits?
is exposed rn as well) - Document it and the
ExFormat
module via@doc
and@moduledoc
directly - Rename
format_string/1
toformat/1
- Finally create the crowd favorite
mix format
task, which takes a list of wildcards and formats all the files that match each wildcard (mix format lib/**/*.ex config/**/*.exs
). This should only useformat/1
and do the file reading/writing "in private" without exposing anything - Write docs for
mix format
- Write a nice concise readme that shows what this project is, what it does, how to use it, and points to the exdoc documentation
uohzxela commented
@whatyouhide thanks for your suggestions. Would it be a good idea to create an escript like ./ex_format
? I read from the docs that it embeds Elixir so the end-user doesn't need to build Elixir v1.6 from source to use the formatter. Thoughts?
whatyouhide commented
An escript is fine too as long as we make the project usable, yep.
uohzxela commented
@whatyouhide great, I've updated the checklist as above.