MakenRosa commented on issue #40403:
URL: https://github.com/apache/superset/issues/40403#issuecomment-4760010915
A small docs-only PR can make this more useful if it replaces the
placeholder with an import that is both real and representative of this package.
Implementation slice:
1. Update `superset-frontend/packages/superset-ui-core/README.md` and remove
the placeholder `import { xxx } from '@superset-ui/core';` example.
2. Prefer an example using stable exports that already appear in Superset
frontend code, such as formatter/i18n utilities, instead of introducing a new
artificial sample.
3. Add a tiny usage snippet under the import so the README demonstrates that
the named exports are callable, not just syntactically valid.
4. Search the package README for any other placeholder tokens like `xxx`,
`TODO`, or copied template text and clean them in the same docs-only change if
present.
5. Run the frontend docs/format checks that Superset expects for Markdown
changes, keeping the PR limited to documentation unless a generated index is
part of the repo workflow.
That should fix the broken example without expanding the scope beyond the
developer README.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
