Make reference-explanation.rst more self-consistent #155
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
Update the introductory paragraph to, when comparing reference and explanation, to lead with reference, for consistency with the title of the page. This was somewhat confusing to me when I was reading this page, because I assumed that it was relating reference to acquisition and explanation to application, and then I got further down the page and it was the other way around.
|
(Aside: I've had diataxis bookmarked for a long time, highly recommended by folks over the years. I'm finally getting around to reading through it and I'm glad I am - thanks for your work on this!) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Update the introductory paragraph to, when comparing reference and explanation, to lead with reference, for consistency with the title of the page.
This was somewhat confusing to me when I was reading this page, because I assumed that it was relating reference to acquisition and explanation to application, and then I got further down the page and it was the other way around.