Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: rename "Main assertions" page to "Main Methods" #1408

Merged
merged 2 commits into from
Oct 7, 2019

Conversation

trentmwillis
Copy link
Member

Fixes #1396

Also fixes some discrepancies between the sidebar and the top navigation.

Copy link
Contributor

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks!

Copy link
Member

@Krinkle Krinkle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Would personally prefer not to uppercase each word though for calmer reading and clearer distinction between the menu items (given only whitespace). "Async Control" was the one that stood out as different from this, I think. I don't feel strongly about it, though.

@trentmwillis
Copy link
Member Author

I used title case because they're the titles of the various pages/sections. That said, I can change it if you feel it helps usability in distinguishing the nav items. At some point, I'd like to invest in the overall design of the API docs, but likely won't have time for that for a while.

@Krinkle Krinkle merged commit acf157c into qunitjs:master Oct 7, 2019
@Krinkle
Copy link
Member

Krinkle commented Oct 7, 2019

Yeah, might just be the Wikipedian in me having an aversion to the classical Title Case. I don't can't think of a rational reason other than (subjective) tradition and indeed the navigation ambiguity, but it's pretty minor. Let's just go with this for now :)

@trentmwillis trentmwillis deleted the gh-1396 branch October 7, 2019 22:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Consider renaming "Main assertions" page
3 participants