Add references to 'Writing documentation' page #737
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eksperimental
suggested changes
Jun 3, 2017
README.md
Outdated
|
|
||
| ExDoc is a tool to generate documentation for your Elixir projects. In case you are looking for documentation for Elixir itself, [check out Elixir's website][elixir-lang]. | ||
|
|
||
| For documentation on writing documentation [check out Elixir's documentation][hex-writing-docs]. |
There was a problem hiding this comment.
three times the word "documentation" in a sentence is a bit too much I think.
How about:
To learn more about how to document this project [check out Elixir's documentation][hex-writing-docs]
There was a problem hiding this comment.
sorry for some reason I thought it this PR was submitted to Elixir.
how about:
To learn about how to document your projects check out [Elixir's writing documentation page][hex-writing-docs]
There was a problem hiding this comment.
I have to admit, it was kind of intentional 😈 , but I can see how it can be confusing
eksperimental
approved these changes
Jun 4, 2017
|
❤️ 💚 💙 💛 💜 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.