rmaake1 / httpstatuses

A directory of HTTP Status Codes and code references
https://httpstatuses.com
MIT License
592 stars 77 forks source link

Status code description clean up and referencing #31

Closed shrink closed 9 years ago

shrink commented 9 years ago

This pull request improves descriptions by removing redundancy from opening paragraphs ("The 200 OK status code indicates that..."), corrects some mistakes from the RFC (e.g: the HTTP 1.1 Specification link in 226 IM Used is broken), and makes a small number of improvements to the display of some pages (e.g: the list on 200 OK is now an actual list).

A better reference style has been added, instead of links being embedded in the middle of sentences they are now footnotes. This has presented one problem, the Markdown is now no-longer pure. GitHub renders the Markdown correctly still, but this may be an issue for third parties who may want to use these Markdown files in their own applications. Need to address that long term. Example of the embedded HTML:


---
* <span id="ref-1"><sup>1</sup> Transformations [Section 5.7.2 of RFC7230][2]</span>
* <span id="ref-2"><sup>2</sup> Warning [Section 5.5 of RFC7234][3]</span>
* <span id="ref-3"><sup>3</sup> Calculating Heuristic Freshness [Section 4.2.2 of RFC7234][4]</span>
* Source: [RFC7231 Section 6.3.4][1]

Only links that make sense as footnotes have been added as footnotes, some links have remained as-is because they fit with the sentence. For example:

A response received with a status code of 226 MAY be stored by a
cache and used in reply to a subsequent request, subject to the HTTP
expiration mechanism and any Cache-Control headers, and to the
requirements in [section 10.6](http://tools.ietf.org/html/rfc3229#section-10.6).

A note needs to be added to the contribution guidelines about when to use footnote references and when to keep links inline.