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

Clarifying MISSING_REFERENCES_TITLE lint #29

Open
wiktor-k opened this issue Feb 14, 2024 · 1 comment
Open

Clarifying MISSING_REFERENCES_TITLE lint #29

wiktor-k opened this issue Feb 14, 2024 · 1 comment
Assignees
Labels
bug Something isn't working component: idnits3

Comments

@wiktor-k
Copy link

Hi,

I'm trying out idnits v3 (3.0.0-alpha.33) and it works great but there's one lint I'm wondering about:

2  Error
 └- Code - MISSING_REFERENCES_TITLE
 └- Desc - The references section is missing a title attribute.
 └- Ref  - https://authors.ietf.org/required-content#references
 └- Path - rfc.back.references[0].title

I've been looking through the already published RFCs but the <reference> tags seem to be missing titles there too:

$ curl -sSL https://www.rfc-editor.org/rfc/rfc8949.xml | grep '<references'
    <references pn="section-11">
      <references pn="section-11.1">
      <references pn="section-11.2">

Where can I learn more about the title attribute and the reasoning for this lint?

(Context: I'm producing the XML from Markdown via mmark but before I submit an issue there I'd like to understand the reasoning).

Thank you for your time! 👋

@NGPixel
Copy link
Member

NGPixel commented Feb 14, 2024

This is indeed a bug.

It should be looking for a <name> element under <references> instead of a title attribute.

@NGPixel NGPixel self-assigned this Feb 14, 2024
@NGPixel NGPixel added bug Something isn't working component: idnits3 labels Feb 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working component: idnits3
Projects
None yet
Development

No branches or pull requests

2 participants