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

WRITEME: fix problematic snippet picker #6887

Open
Laren-AWS opened this issue Sep 20, 2024 · 0 comments
Open

WRITEME: fix problematic snippet picker #6887

Laren-AWS opened this issue Sep 20, 2024 · 0 comments
Assignees

Comments

@Laren-AWS
Copy link
Contributor

The snippet picking code in .tools/readmes/scanner.py that determines which snippet to link to in the README could be better. Currently, it picks the first snippet listed for scenarios, which isn't always the best choice and causes some pain for example writers.

Probable solution is to implement a way to tag a snippet in the metadata as the "primary" or "linkable" so that WRITEME can deterministically find it and use it.

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

No branches or pull requests

1 participant