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

Snippet index: support for enumerating custom features #8386

Merged
merged 2 commits into from
Dec 10, 2024

Conversation

teh-cmc
Copy link
Member

@teh-cmc teh-cmc commented Dec 10, 2024

Adds the ability to manually enumerate custom things.

E.g.:

# These arbitrary feature names will be indexed exactly as written down.
# Add anything you can think about!
[snippets_ref.features]
"Dataframes" = [
  "reference/dataframe_query",
  "reference/dataframe_view_query",
]
"`AnyValue`" = [
  "tutorials/any_values",
  "tutorials/extra_values",
  "howto/any_values_send_columns",
]

Config will have to be filled over time!

Rendered

@teh-cmc teh-cmc added 📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples do-not-merge Do not merge this PR exclude from changelog PRs with this won't show up in CHANGELOG.md labels Dec 10, 2024
Copy link

github-actions bot commented Dec 10, 2024

Web viewer failed to build.

| Result | Commit | Link | Manifest |
| ------ | ------- | ----- |
| ❌ | | https://rerun.io/viewer/pr/8386 | +nightly +main |

Note: This comment is updated whenever you push a commit.

@teh-cmc teh-cmc force-pushed the cmc/snippets_index_2_opt_outs branch from 0315edb to f627739 Compare December 10, 2024 16:36
Base automatically changed from cmc/snippets_index_2_opt_outs to main December 10, 2024 16:36
@teh-cmc teh-cmc force-pushed the cmc/snippets_index_3_features branch from 890a624 to 41526f0 Compare December 10, 2024 16:42
@teh-cmc teh-cmc removed the do-not-merge Do not merge this PR label Dec 10, 2024
@teh-cmc teh-cmc merged commit 1a1c5de into main Dec 10, 2024
27 of 29 checks passed
@teh-cmc teh-cmc deleted the cmc/snippets_index_3_features branch December 10, 2024 16:44
teh-cmc added a commit that referenced this pull request Dec 10, 2024
Might be a controversial one. I think it's already useful enough to
quietly link to it.

* DNM: requires #8386
teh-cmc added a commit that referenced this pull request Dec 10, 2024
Archetype snippets should follow the model
`{archetype_name_snake_case}_{snippet_name}`.

[Index
rendered](https://github.com/rerun-io/rerun/blob/cmc/snippets_index_4_cleanup_data/docs/snippets/INDEX.md)

Reasons:
A) Consistency.
B) Snippets that contain the name of an archetype bubble up in the
snippet index (when grepping for Points3D, you are likely more
interested in points3d_simple vs. transform_hierarchy_mega_test_of_deth,
even though both of them reference Points3D).

* DNM: requires #8386
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 examples Issues relating to the Rerun examples exclude from changelog PRs with this won't show up in CHANGELOG.md
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants