Misc doc changes #144
Misc doc changes #144
Conversation
.gitignore
Outdated
| @@ -1,14 +1,14 @@ | |||
| # The directory Mix will write compiled artifacts to. | |||
| /_build | |||
| /_build/ | |||
There was a problem hiding this comment.
Unnecessary change. Please revert all these trailing slashes.
.gitignore
Outdated
|
|
||
| # Where 3rd-party dependencies like ExDoc output generated docs. | ||
| /doc | ||
| # Where third-party dependencies like ExDoc output generated docs. |
There was a problem hiding this comment.
Unnecessary change, please revert :)
.gitignore
Outdated
|
|
||
| # If you run "mix test --cover", coverage assets end up here. | ||
| /cover | ||
| /cover/ |
.gitignore
Outdated
| # Temporary files for e.g. tests. | ||
| /tmp/ |
There was a problem hiding this comment.
I ran tests and nothing generated anything in /tmp. Please remove this.
There was a problem hiding this comment.
I ran tests and nothing generated anything in
/tmp. Please remove this.
Noted. FYI, the .gitignore was copied and merged into existing .gitignore from generated file from mix new foobar using latest Elixir version.
README.md
Outdated
| ## Copyright and License | ||
| Copyright (c) 2017 Bing Han | ||
| This library is MIT licensed. See the | ||
| [LICENSE](https://github.com/tony612/protobuf-elixir/blob/master/LICENSE) for details. |
There was a problem hiding this comment.
Did @tony612 request this change? Let's drop it otherwise.
There was a problem hiding this comment.
Did @tony612 request this change? Let's drop it otherwise.
Nope and I'll remove it for now. But good to put copyright and license details in the readme.
Our of curiosity, looking at the GitHub repo URL change, is this Elixir library now under the co-maintenance between @tony612 and Elixir core team?
lib/protobuf/protoc/context.ex
Outdated
| defstruct plugins: [], | ||
|
|
||
| ### All files scope | ||
| ### All files scope |
There was a problem hiding this comment.
Please revert the changes in this file, the new formatting is not the one supported by the formatter so there is no reason in reformatting this file :)
There was a problem hiding this comment.
Please revert the changes in this file, the new formatting is not the one supported by the formatter so there is no reason in reformatting this file :)
Formatting as in Markdown formatting or Protobuf formatting?
mix.exs
Outdated
| files: [ | ||
| "mix.exs", | ||
| "README.md", | ||
| "lib/google", | ||
| "lib/protobuf", | ||
| "lib/*.ex", | ||
| "src", | ||
| "LICENSE", | ||
| "priv/templates", | ||
| ".formatter.exs" | ||
| ] |
There was a problem hiding this comment.
This is an unnecessary change. Can you revert it?
| defp docs do | ||
| [ | ||
| extras: ["README.md"], | ||
| main: "readme", | ||
| source_url: @source_url, | ||
| source_ref: "v#{@version}" |
|
Awesome job, thanks @kianmeng! Can you rebase this on master? Once you do, we'll be good to merge! |
Besides other changes, this commit ensures the generated HTML doc for HexDocs.pm will become the main source doc for this Elixir library which leverage on ExDoc features. Co-authored-by: Andrea Leopardi <an.leopardi@gmail.com>
kianmeng
force-pushed
the
misc-doc-changes
branch
from
66dc186 to
92421b0
Compare
@whatyouhide Done. Please check |
|
Thanks @kianmeng! 💟 |
2 participants
Besides other changes, this commit ensures the generated HTML doc for
HexDocs.pm will become the main source doc for this Elixir library which
leverage on ExDoc features.