httpwg / admin

When you want to speak to the manager.
9 stars 15 forks source link

style: how does one define new parameters #59

Open DavidSchinazi opened 3 weeks ago

DavidSchinazi commented 3 weeks ago

The Concealed auth draft defines new HTTP authentication parameters. Over in https://github.com/httpwg/http-extensions/issues/2801 we realized that the syntax for how to define new parameters and how to refer to those parameters wasn't consistent. I went to check the style guide, and there was no guidance. I picked something consistent for that draft, but it would be good to provide guidance in the style guide, similar to the guidance we provide for header field names.

For what it's worth, what I picked in that draft was:

Note that "Parameter" is uppercase here, would be good to suggest whether upper- vs lower-case is preferred.

mnot commented 3 weeks ago

Capitalising "Parameter" may confuse people with Structured Fields terminology; HTTP auth doesn't use SF.

Otherwise looks good.