x/pkgsite: automatically link RFCs in package documentation #38056
What is the URL of the page with the issue?
godoc.org would automatically link to RFCs
What did you expect to see?
RFCs automatically linked
What did you see instead?
RFCs were not automatically linked
This was a really nice feature of godoc!
The text was updated successfully, but these errors were encountered:
I think we want to strike a good balance of being opinionated, so that it incentivizes people to write higher quality, consistent documentation, but not too opinionated where we are unnecessarily strict in a way that isn't helpful to humans.
The Go tree is heavily consistent at preferring including a space. There are 700 matches for
In my opinion, based on data I see now, it would be safe to start with requiring a space, but if we learn over time that it would be net positive to also accept the no-space version, we can add that later.
@FiloSottile may know if there's a spec that requires a space to be present or provides other guidance on what syntax to match precisely.
This appears to be documented in RFC 7322, Section 3.5 which states: