Updating description and adding long description #124
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
amilstead
reviewed
Jun 5, 2018
setup.py
Outdated
| @@ -20,7 +20,11 @@ | |||
| setup( | |||
| name='optimizely-sdk', | |||
| version=__version__, | |||
| description="SDK for Optimizely's Full Stack Python project.", | |||
| description='Python SDK for Optimizely X Full Stack.', | |||
| long_description='Optimizely X Full Stack is A/B testing and feature management for product development teams. ' | |||
There was a problem hiding this comment.
A more standard approach to this is to set the value of long_description to the contents of a README.md (or similar) prepended to the contents of the CHANGELOG.md (or similar).
e.g.
with open('README.md') as _file:
README = _file.read()
with open('CHANGELOG.md') as _file:
CHANGELOG = _file.read()
setup(
...
long_description=README + '\n\n# Change Log: \n' + CHANGELOG
...
)
Any thoughts?
There was a problem hiding this comment.
Yeah i noticed that in some implementations.
How about we do the message mentioned here + README + CHANGELOG?
There was a problem hiding this comment.
Don't forget to add those files in the MANIFEST.in so they're included in the package distribution. Installs will fail if without them.
There was a problem hiding this comment.
Good call. Need README there.
aliabbasrizvi
force-pushed
the
ali/update_description
branch
from
f7cd53b to
e0f8c0f
Compare
spencerwilson-optimizely
approved these changes
Jun 8, 2018
setup.py
Outdated
| about_text = 'Optimizely X Full Stack is A/B testing and feature management for product development teams. ' \ | ||
| 'Experiment in any application. Make every feature on your roadmap an opportunity to learn. ' \ | ||
| 'Learn more at https://www.optimizely.com/products/full-stack/ or see our documentation at ' \ | ||
| 'https://developers.optimizely.com/x/solutions/sdks/reference/index.html?language=python' |
There was a problem hiding this comment.
nit: maybe a period at the end?
There was a problem hiding this comment.
Good call. Will add.
aliabbasrizvi
added a commit
that referenced
this pull request
Jun 19, 2018
spencerwilson-optimizely
added a commit
to optimizely/javascript-sdk
that referenced
this pull request
Jul 3, 2018
## Summary - Add the same Full Stack description to the top of the READMEs here that @jonslaught advised to for python-sdk in optimizely/python-sdk#124 - Clarify Lerna usage: no multiple packages, for now - Fix stale package name in root readme, and fix the NPM badge that also was based on it - Add badges to `@optimizely/optimizely-sdk`'s README - Precisely document supported JavaScript environments - Add note about default `EventDispatcher`s. (I have mixed feelings on this; happy to hear opinions) - Make `Contributing` section more concise - Drop references to `dist/` artifacts, since #135 made them no longer a thing [Rendered](https://github.com/optimizely/javascript-sdk/blob/sw/readme/packages/optimizely-sdk/README.md)
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.
No description provided.