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

[Investigation/Discussion] How should we format API usage examples? #139

Open
wvauclain opened this issue Jul 15, 2020 · 1 comment
Open
Labels
advanced topics advanced topics discussion Ideas and discussions that might lead to more specific actionable issues future thoughts

Comments

@wvauclain
Copy link

Eventually we want to include examples on how to use the refine.bio API. I have an example using python to generate quant-only datasets, which I wrote for one of our users.

How should we format these examples? For all of our other examples we are using Rmarkdown, but would that work/be the best approach for API examples too?

@jashapiro
Copy link
Member

In theory, we could. I have not tested it, but Rmarkdown theoretically handles Python blocks just fine.

https://bookdown.org/yihui/rmarkdown/language-engines.html#python

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
advanced topics advanced topics discussion Ideas and discussions that might lead to more specific actionable issues future thoughts
Projects
None yet
Development

No branches or pull requests

3 participants