Clarify that this sends your markdown to GitHub #251
Merged
Conversation
This file contains 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
The current wording allows for the misinterpretation that the rendering is being done locally. "Github markdown API" could mean a library published by GitHub, and "The styles come directly from GitHub" could mean just the CSS stylesheet. This should be corrected, because if misinterpreted this way it leads to 2 false assumptions: - Your data is not being sent to a third party - This will work offline I know information later in the readme talks about API rate limits and such, but many people won't read past the Usage section (myself included apparently). I think in particular the repeated mentions of a "local readme file" gave me this mistaken impression. I think mentioning REST and saying that the rendering is done by GitHub is sufficient, but there may be some other change that clarifies this better.
|
Ha! Yes please! Not a problem for me, but I was definitely misled at first. |
|
This sounds good to me. Good suggestion! One minor tweak maybe. Could you remove the "REST" addition? It's slightly noisier and doesn't make much of a difference to the reader if it's sent using the REST API vs the Graphql one. Also, any chance can you rebase this onto |
wip-sync
pushed a commit
to NetBSD/pkgsrc-wip
that referenced
this pull request
Apr 30, 2024
- Fix "ImportError: cannot import name 'safe_join' from 'flask'" when using Flask 2.1.0+ ([#360](joeyespo/grip#360) - thanks, [@bryce-carson][]!) - Update output and **fix style issues** - Add support for **Python 3.7, 3.8, 3.9, 3.10** - Improve handling of PDFs and other binary files - Fix deprecation warnings from newer dependency versions - End-of-life [Python versions](https://devguide.python.org/#status-of-python-branches) no longer intentionally supported - Python 2.6, 2.7 (Python 2 compatibility will be removed entirely in the next major release) - Python 3.0, 3.1, 3.2, 3.3 ([#275](joeyespo/grip#275) - thanks, [@svisser][]!), 3.4, 3.5, 3.6 - Current [dependency versions](requirements.txt) (more recent versions will be required in the next major release) - Fix typo in error message ([#266](joeyespo/grip#266) - thanks, [@Godron629][]!) - Update HTML/CSS scaffold to match GitHub ([#297](joeyespo/grip#297) - thanks, [@phyllisstein][]!) - Fix tests by adding a missing `USER_CONTEXT` argument to one of the `GitHubRenderer` calls - Serve non-`text/` MIME types as raw files for better handling of, e.g. PDF files ([#234](joeyespo/grip#234) - thanks, [@wvspee][]!) - Fix style parsing, which caused some styles to be missing ([#347](joeyespo/grip#347)) - Readme: Update to correct `--no-inline` option ([#267](joeyespo/grip#267) - thanks, [@TomDLT][]!) - Readme: Fix links to Grip class ([#276](joeyespo/grip#276) - thanks, [@jacebrowning][]!) - Readme: Clarify that this sends your markdown to GitHub ([#251](joeyespo/grip#251) - thanks, [@courajs][]!) - Update `pytest` usages (see [pytest 3.0.0 changelog](https://github.com/pytest-dev/pytest/blob/master/CHANGELOG.rst#300-2016-08-18)) - Add `.pytest_cache` to `.gitignore` ([#287](joeyespo/grip#287) - thanks, [@svisser][]!) - Add `.venv` and `.idea` to `.gitignore` and clean up - Add `flake8` test dependency and fix linting errors ([#299](joeyespo/grip#299)) - Add `pytest` test dependency ([#294](joeyespo/grip#294) - thanks, [@Methacrylon][]!) - License: Distribute LICENSE file ([#274](joeyespo/grip#274) - thanks, [@synapticarbors][]!) - License: Update year
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.
The current wording allows for the misinterpretation that the rendering is being done locally.
"Github markdown API" could mean a library published by GitHub, and "The styles come directly from GitHub" could mean just the CSS stylesheet.
This should be corrected, because if misinterpreted this way it leads to 2 false assumptions:
I know information later in the readme talks about API rate limits and such, but many people won't read past the Usage section (myself included apparently). I think in particular the repeated mentions of a "local readme file" gave me this mistaken impression.
I think mentioning REST and saying that the rendering is done by GitHub is sufficient, but there may be some other change that clarifies this better.