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

Misleading errata links #4446

Open
mattgarrish opened this issue May 10, 2023 · 2 comments
Open

Misleading errata links #4446

mattgarrish opened this issue May 10, 2023 · 2 comments

Comments

@mattgarrish
Copy link
Member

mattgarrish commented May 10, 2023

We have to add an errata link for W3C RECs, but even though the errata file contains no errata respec adds the field:

Errata:
Errata exists.

This is misleading for newly published specifications that don't have any errata, as it pointlessly sends users to the errata file. I'm sure we'll get reports about it, and at some point users will probably just tune out the message, potentially missing when errata really is published.

I don't know that there's a perfect solution to this, as you probably can't republish the specification when you add errata to change the message, but can we use a label that doesn't definitively say that there is errata?

Maybe something like "Check for errata"?

@iherman
Copy link
Member

iherman commented May 10, 2023

The usual boilerplate seems to be:

Please check the errata for any errors or issues reported since publication.

With "errata" linking to the errata file.

@mattgarrish
Copy link
Member Author

Maybe it should just be the URL to the errata file?

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

2 participants