search

icann / rfc-annotations

Other
8 stars 7 forks source link

remind users that line number references to recent RFCs may be unstable #22

Closed reschke closed 2 years ago

reschke commented 2 years ago

Documentation? Warning during program run?

mboe commented 2 years ago

If I understand the situation correctly the line numbers are (or at least can be) unstable for all RFCs which are available in XML file format (>= 8650).

If this is the case I'd like to add this information to the documentation and add a warning if #L references are used for RFCs >= 8650.

mboe commented 2 years ago

As soon as the PR is merged these annotations should be changed (and use the new #F reference type instead):

Warning: File annotations/from-icann/icann-errata/rfc8906.erratum.6783 contains reference to line#807. Line references for RFC8650 and newer may be unstable.
Warning: File annotations/from-icann/icann-errata/rfc8932.erratum.6629 contains reference to line#1560. Line references for RFC8650 and newer may be unstable.
Warning: File annotations/from-icann/icann-errata/rfc8976.erratum.6425 contains reference to line#1154. Line references for RFC8650 and newer may be unstable.
Warning: File annotations/_generated/rfc8976.erratum.6425 contains reference to line#1154. Line references for RFC8650 and newer may be unstable.