Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support alternate examples in README template #49

Open
malandis opened this issue Feb 1, 2023 · 0 comments
Open

Support alternate examples in README template #49

malandis opened this issue Feb 1, 2023 · 0 comments

Comments

@malandis
Copy link
Contributor

malandis commented Feb 1, 2023

Some clients, especially python, have multiple examples that a prospective user should know about. Some of these are version specific, so they cannot be rolled up into a single large example. Because of these, the README generator should support an "alternate example" section. This should support both a header/snippet as well as the code location, eg

"Non-pattern matching example (python <3.10)", "./examples/prepy310/example.py"
"AsyncIO client example (python <3.10)", "./examples/prepy310/example_async.py"

See momentohq/client-sdk-python#219

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant