README: various improvements#2
Open
waldyrious wants to merge 1 commit into
Open
Conversation
waldyrious
commented
Mar 23, 2018
waldyrious
commented
- format filenames as code
- highlight data source types as bold, for readability
- add links to dependencies
- format sub-headings in "Description of files" section
- improve line wrapping a bit
- slightly reword a few passages for additional clarity
- format filenames as code - highlight data source types as bold, for readability - add links to dependencies - format sub-headings in "Description of files" section - improve line wrapping a bit - slightly reword a few passages for additional clarity
Author
|
To be honest, the main reason I even started editing this file was to have a place to express my appreciation for the excellent documentation of this package, especially the flowchart diagram at the end of the README :) It makes it very easy to get a quick overview and to jump in. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.