Update READMEs #148
Merged
Update READMEs #148
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
Pike
force-pushed
the
readmess
branch
2 times, most recently
from
21cafbf to
78d3124
Compare
Our READMEs on the fluent packages are lacking. Create some, and use them in setup.py to add better content on pypi. Also convert to restructuredText to align with rest of docs. The documentation for fluent.pygments is really just to demo the highlighting.
stasm
approved these changes
May 20, 2020
fluent.runtime/README.rst
Outdated
| =============================== | ||
|
|
||
| Use `Fluent`_ to localize your Python application. It comes with a ``Localization`` | ||
| class to use, based on an implementation of bundle. It uses the parser from |
Contributor
There was a problem hiding this comment.
The way it's used here, bundle is a bit enigmatic. Perhaps mention FluentBundle, i.e. the class?
(I realize this is copied from the current README; if you'd prefer to fix this later rather than in a drive-by, that's fine with me.)
Contributor
Author
There was a problem hiding this comment.
Fixed this in both READMEs.
fluent.syntax/README.rst
Outdated
| ``fluent.syntax`` |fluent.syntax| | ||
| --------------------------------- | ||
|
|
||
| Process, analyze, and transform `Fluent`_ files. |
Contributor
There was a problem hiding this comment.
Perhaps explicitly mention parsing and serializing?
Contributor
There was a problem hiding this comment.
Or: Read, write, and transform...?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Our READMEs on the fluent packages are lacking.
Also convert to restructuredText to align with rest of docs.