Closed Bug 1588234 Opened 6 years ago Closed 6 years ago

Capitalization of letters for documentation webpages

Categories

(developer.mozilla.org Graveyard :: General, enhancement)

All
Other
enhancement
Not set
normal

Tracking

(Not tracked)

RESOLVED WONTFIX

People

(Reporter: silveraliaz, Assigned: cmills)

Details

(Keywords: in-triage, Whiteboard: [specification][type:change])

What feature should be changed? Please provide the URL of the feature if possible.

I felt like, documentation webpage should not have their first letters capitalized. Right now, all of those are capitalized, but unfortunately, not all code are case insensitive. Say, for example, for the page:
https://developer.mozilla.org/en-US/docs/Web/API/Document/body

The content itself event listed Document.body, but that isn't really correct.

What problems would this solve?

Clarity, for people who may not be familiar with the content, which is what the content is written for - partially at least.

Who would use this?

Everybody

What would users see?

not capitalized code

What would users do? What would happen as a result?

Users would feel smarter because it worked when they copy and pasted code :)

Is there anything else we should know?

No, disappointing right?

Status: UNCONFIRMED → RESOLVED
Closed: 6 years ago
Resolution: --- → INVALID

I don't know if this is valid or not. Maybe it isn't.

Status: RESOLVED → UNCONFIRMED
Resolution: INVALID → ---
Assignee: nobody → cmills
Keywords: in-triage

You have a good point here. Ideally something like Document.body should actually be document.body, as the document object you are using is actually an instance of the Document class.

The other option for correctness would be to make it Document.prototype.body, but that would make titles longer and confuse beginners who don't understand how OOJS works.

In any case, we are not fixing this issue right now, as it would take far too long and is low priority compared to the other things we've got to do. But we are aiming to do this correctly for the new version of MDN, aka Stumptown.

So thanks for the submission, and sorry we've not got better news about this in the short term.

Status: UNCONFIRMED → RESOLVED
Closed: 6 years ago6 years ago
Resolution: --- → WONTFIX
Product: developer.mozilla.org → developer.mozilla.org Graveyard
You need to log in before you can comment on or make changes to this bug.