Bug 939845 - Bring login documentation up-to-date #211
Conversation
| @@ -1,33 +1,278 @@ | |||
| login.webmaker.org | |||
| login.webmaker.org (core) <a name="top"> | |||
There was a problem hiding this comment.
this is not how named anchors work anymore, and is in fact incorrect HTML use under HTML5 rules. Nav links will link straight to anything with an id element, so if you really want to build a ToC, simply give the text you want to link to a span with an id, and link to that in the same way, using http://.... /...#idname. That said, github will already do this for you. Headings are autolinked.
| Update a Webmaker profile | ||
|
|
||
| Call Parameters: | ||
| :email - the "email" parameter of the Webmaker User model (see schema at top of page) |
There was a problem hiding this comment.
what documentation did you base this notation on? Node happens to use : for its named fragments, but just because that's how Node does it doesn't mean our API will always be implemented in Node, so let's use a syntax that does not rely on the specific technology used in the implementation. Also note that if it's part of the URI proper, it's not a "call parameter" so much as just part of the URI. If it were a ...?email=... query argument, it might be a call parameter.
There was a problem hiding this comment.
I hear ya, but it needs to be called something. In the case where it isn't a query (i.e. not ...?email=...), how can I refer to it specifically? It's part of the URI, but what is it?
…for the login server
ref: https://bugzilla.mozilla.org/show_bug.cgi?id=939845