Skip to content

Comments

Improve docs for TextDocument example#4008

Merged
emilk merged 17 commits intomainfrom
emilk/better-text-document-docs
Oct 26, 2023
Merged

Improve docs for TextDocument example#4008
emilk merged 17 commits intomainfrom
emilk/better-text-document-docs

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
@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

Development

Successfully merging this pull request may close these issues.

Text document archetype documentation should document how component/entity links work Text document archetype documentation doesn't render correctly

2 participants