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

Improve docs for TextDocument example #4008

Merged
merged 17 commits into from Oct 26, 2023
Merged

Conversation

emilk
Copy link
Member

@emilk emilk commented Oct 25, 2023

What

This enabled the API-docs for the TextDocument example. To make sure it renders correctly I needed to:

  • Remove the -code block (for proper embedding in the website inside of a markdown block)
  • Replace """" with '''' in the python example, so it can be embedded in a """-docstring in the Python API docs

Python API docs:

image

Rust API docs:

image

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested demo.rerun.io (if applicable)
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG

@emilk emilk added 📖 documentation Improvements or additions to documentation include in changelog labels Oct 25, 2023
@emilk emilk marked this pull request as ready for review October 25, 2023 14:35
@Wumpf Wumpf requested review from Wumpf and removed request for Wumpf October 25, 2023 14:44
@emilk emilk merged commit fe9759a into main Oct 26, 2023
34 checks passed
@emilk emilk deleted the emilk/better-text-document-docs branch October 26, 2023 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation include in changelog
Projects
None yet
2 participants