fix(docs): correct enum member names in SDK doc examples - #615
Open
sastaachar wants to merge 1 commit into
Open
Conversation
Doc comments are the source for the public API reference and are read verbatim by code-generating consumers, so an example naming a member that does not exist ships code that will not compile. ListPageColumns.Favorite was the reported case; a sweep of every EnumName.Member reference in the comments found 11 more. - ListPageColumns.Favorite -> Favorites - EmbedEvent.DrillDown -> Drilldown - EmbedEvent.customAction -> CustomAction - EmbedEvent.DownloadAsPDF -> DownloadAsPdf - EmbedEvent.DownloadAsCSV -> DownloadAsCsv (x3) - EmbedEvent.DownloadAsXLSX -> DownloadAsXlsx - HostEvent.ScheduleList -> SchedulesList (x2) - Action.Export -> ExportTML (x2) - InterceptedApiType.DATA -> LiveboardData - AuthEvent.SUCCESS -> AuthStatus.SUCCESS (wrong enum) - useEmbedRef example: EmbedEvent.UpdateRuntimeFilter -> HostEvent.UpdateRuntimeFilters (wrong enum and singular member; trigger() takes a HostEvent) EmbedEvent.FatalError is left as-is: it is a documented forward reference to a planned event. SCAL-327608
commit: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Doc comments are the source for the public API reference and are read verbatim by code-generating consumers, so an example naming a member that does not exist ships code that will not compile. ListPageColumns.Favorite was the reported case; a sweep of every EnumName.Member reference in the comments found 11 more.
HostEvent.UpdateRuntimeFilters (wrong enum and singular member;
trigger() takes a HostEvent)
EmbedEvent.FatalError is left as-is: it is a documented forward reference to a planned event, and is allowlisted in the new spec.
Adds src/enum-doc-references.spec.ts, which reparses the enums and fails on any doc reference to a member that does not exist.
SCAL-327608