Sitelet https://github.com/androidx/androidx/pull/891
Skip to content

Fix Room Index name docs markdown swallowing underscores - #891

Open
michd wants to merge 1 commit into
androidx:androidx-mainfrom
michd:patch-1
Open

michd wants to merge 1 commit into
androidx:androidx-mainfrom
michd:patch-1

Conversation

@michd

@michd michd commented Jul 7, 2026

Copy link
Copy Markdown

https://developer.android.com/reference/androidx/room#getName()

In the resulting documentation page, the underscores used in the description were interpreted as markdown and thus not displayed as characters documenting the generated index name. Use of backticks preserves them and will display as intended when run through the markdown converter.

Additionally, a correction (assuming the worked example is correct) is included when describing the prefix.

Proposed Changes

  • Use backticks in the method description to preserve underscore literals in output HTML
  • Add missing underscore in the described prefix after table name

Testing

Test: None; this is a documentation change.

In the resulting documentation webpages, the underscores used in the description were interpreted as markdown and thus not displayed as characters documenting the generated index name. Use backticks preserves them and will display as intended when run through the markdown converter.

Additionally, a correction (assuming the worked example is correct) is included when describing the prefix.

This branch has not been deployed

No deployments
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

Successfully merging this pull request may close these issues.

1 participant