1180429 - Add headers for classes in TOC of Puppeteer docs

Status: RESOLVED FIXED

(Testing :: Firefox UI Tests, defect)

Description

[utvar]

User Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.6; rv:39.0) Gecko/20100101 Firefox/39.0
Build ID: 20150630154324

Steps to reproduce:

I navigated to Puppeteer Read the Docs (via GitHub link or search engine results) and looked at drop-down menus for the libraries in the main table of contents on the left. 


Actual results:

Some libraries had all of their classes listed in drop-down menu, but others were missing one or all of the classes they contain. 


Expected results:

I expected all of the libraries to have all their classes listed in the table of contents.

Comment 1

[utvar]

I have started addressing this issue here: https://github.com/mozilla/firefox-ui-tests/pull/210

Comment 2

[utvar]

Attachment: GitHub pull request

Comments on GitHub.

Comment 3

[Chris Manchester (limited bugmail, email directly)]

Comment on attachment 8632478 [details] [review]
GitHub pull request

Thanks for the PR, this looks like a good change to me! Is there anything you'd like feedback on in particular before I merge this in?

Comment 4

[utvar]

(In reply to Chris Manchester [:chmanchester] from comment #3)

I wanted to be sure you approved of the removal of the "API Reference" headers. I believe it makes the TOC clearer to have all the classes show up directly under the name of the library, but if you prefer, I could add another layer to the TOC and index, which would nest class names inside the "API Reference" header.

Comment 5

[utvar]

Comment on attachment 8632478 [details] [review]
GitHub pull request

Please see Bug 1180429, Comment4.

Comment 6

[Chris Manchester (limited bugmail, email directly)]

Comment on attachment 8632478 [details] [review]
GitHub pull request

Looks good! I'll merge this in a moment.

Comment 7

[Chris Manchester (limited bugmail, email directly)]

Merged to master in https://github.com/mozilla/firefox-ui-tests/commit/42d9132e31869d1b1baaf752b881233c9bcd3972

Comment 8

[Henrik Skupin [:whimboo][⌚️UTC+2]]

We needed this patch for esr38 to get some other important patches backported. So I cherry-picked this commit:

https://github.com/mozilla/firefox-ui-tests/commit/b24a98110e31dbc48b5737678c69d1e73baa6542 (esr38)