search

aio-libs / aiohttp-security

auth and permissions for aiohttp
Apache License 2.0
229 stars 68 forks source link

"Basic" terminology is misleading #591

Closed toolforger closed 1 year ago

toolforger commented 1 year ago

The docs say "basic auth example" (or similar), so people looking for HTTP Basic Auth will be confused because it means "basic (auth example)", not "(basic auth) example". (Human language is not associative...)

Alternate terms: "simple" "tutorial" "baseline" "example" "basic usage"

I.e. it would be best to avoid the word combination "basic auth" in the docs, even if readers are not meant to parse it that way.

Dreamsorcerer commented 1 year ago

Feel free to just edit it and we'll review in the PR. Though I'm not sure people are expecting to find Basic Auth things in aiohttp-security, you don't need a library to handle that.

toolforger commented 1 year ago

While getting Basic Auth right is admittedly trivial, teaching material is surprisingly hard to come by (searching for "basic" and "auth" will typically find you basic introductions to session auth). I guess that's why libraries such as aiohttp-basicauth exist (not recommended as best practice for security, but does all the aiohttp integration and the HTTP basic auth stuff so it's a starting point).