search

ietf-wg-httpapi / ratelimit-headers

Repository for IETF WG draft ratelimit-headers
Other
45 stars 5 forks source link

Fix warnings: long lines, doc references, ... #16

Closed ioggstream closed 2 years ago

ioggstream commented 3 years ago

I expect

No warnings

Instead

/github/workspace/draft-ietf-httpapi-ratelimit-headers.xml(1411): Warning: Too long line found (L1320), 41 characters longer than 72 characters: 
   RateLimit-Limit: 100, 100;w=60;burst=1000;comment="sliding window", 5000;w=3600;burst=0;comment="fixed window"
/github/workspace/draft-ietf-httpapi-ratelimit-headers.xml(1512): Warning: Too long line found (L1419), 7 characters longer than 72 characters: 
   RateLimit-Remaining: 6          ; using 50% of throughput, that is 6 units/s
/github/workspace/draft-ietf-httpapi-ratelimit-headers.xml(1518): Warning: Too long line found (L1425), 9 characters longer than 72 characters: 
   RateLimit-Remaining: 1          ; using 100% of throughput, that is 12 units/s
richsalz commented 3 years ago

There are six lines that are marked as too long.:

   GET /books/123                  ; service-limit=4, remaining: 3, status=200
   GET /books?author=Camilleri     ; service-limit=4, remaining: 1, status=200
   GET /books?author=Eco           ; service-limit=4, remaining: 0, status=429
   RateLimit-Limit: 100, 100;w=60;burst=1000;comment="sliding window", 5000;w=3600;burst=0;comment="fixed window"
   RateLimit-Remaining: 6          ; using 50% of throughput, that is 6 units/s
   RateLimit-Remaining: 1          ; using 100% of throughput, that is 12 units/s

It might make sense to break these into two lines:

   GET /books/123 ;\\
                 service-limit=4, remaining: 3, status=200

and add text saying "Shown on two lines for clarity" or something.

ioggstream commented 3 years ago

3 fixed ;)

darrelmiller commented 2 years ago

@ioggstream Can this be closed now?