diff --git a/gae/lib/markdown/extensions/toc.py b/gae/lib/markdown/extensions/toc.py index 56db33c50d1..6c39d869f1e 100644 --- a/gae/lib/markdown/extensions/toc.py +++ b/gae/lib/markdown/extensions/toc.py @@ -285,7 +285,7 @@ def __init__(self, *args, **kwargs): "slugify": [slugify, "Function to generate anchors based on header text - " "Defaults to the headerid ext's slugify function."], - 'separator': ['-', 'Word separator. Defaults to "-".'] + 'separator': ['_', 'Word separator. Defaults to "-".'] } super(TocExtension, self).__init__(*args, **kwargs) diff --git a/src/content/en/fundamentals/getting-started/primers/promises.md b/src/content/en/fundamentals/getting-started/primers/promises.md index ca52342274c..59906c75734 100644 --- a/src/content/en/fundamentals/getting-started/primers/promises.md +++ b/src/content/en/fundamentals/getting-started/primers/promises.md @@ -24,7 +24,7 @@ At this point you fall into one of these categories: * You punch the air! About time right? You've used these Promise things before but it bothers you that all implementations have a slightly different API. What's the API for the official JavaScript version? You probably want to begin with the [terminology](#promise-terminology). * You knew about this already and you scoff at those who are jumping up and down like it's news to them. Take a moment to bask in your own superiority, then head straight to the [API reference](#promise-api-reference). -## What's all the fuss about? +## What's all the fuss about? {: #whats-all-the-fuss-about } JavaScript is single threaded, meaning that two bits of script cannot run at the same time; they have to run one after another. In browsers, JavaScript shares a thread with a load of other stuff that differs from browser to browser. But typically JavaScript is in the same queue as painting, updating styles, and handling user actions (such as highlighting text and interacting with form controls). Activity in one of these things delays the others. @@ -108,7 +108,7 @@ At their most basic, promises are a bit like event listeners except: This is extremely useful for async success/failure, because you're less interested in the exact time something became available, and more interested in reacting to the outcome. -## Promise terminology +## Promise terminology {: #promise-terminology } [Domenic Denicola](https://twitter.com/domenic) proof read the first draft of this article and graded me "F" for terminology. He put me in detention, forced me to copy out [States and Fates](https://github.com/domenic/promises-unwrapping/blob/master/docs/states-and-fates.md) 100 times, and wrote a worried letter to my parents. Despite that, I still get a lot of the terminology mixed up, but here are the basics: @@ -834,7 +834,7 @@ This throws together a lot of new ES6 stuff: promises, generators, let, for-of. This pattern is so useful, it's coming to ES7 in the form of [async functions](https://jakearchibald.com/2014/es7-async-functions/). It's pretty much the same as above, but no need for a `spawn` method. -## Promise API reference +## Promise API reference {: #promise-api-reference } All methods work in Chrome, Opera, Firefox, Microsoft Edge, and Safari unless otherwise noted. [The polyfill](https://github.com/jakearchibald/ES6-Promises#readme) provides the below for all browers. diff --git a/src/content/en/resources/style-guide.md b/src/content/en/resources/style-guide.md index f1ad495be02..dd1a1ee209e 100644 --- a/src/content/en/resources/style-guide.md +++ b/src/content/en/resources/style-guide.md @@ -16,7 +16,7 @@ find that you need to create a new style that will apply to more than a single page, please file an issue on GitHub so that other pages can use it as well. This ensures site-wide consistency. -## Headings +## Headings The top-most heading of the page is the page's title. The page body must not contain another `

`, to avoid confusing non-visual browsers. @@ -26,13 +26,20 @@ contain another `

`, to avoid confusing non-visual browsers. Page Titles (`h1`) : Use Title Case for All Major Words -Page Headings (`h2`-`h6`) +Section headings (`h2`-`h6`) : Use sentence case for all headings Yes, we're inconsistent about this, but we're trying to fix it, please do your best to ahear to these guideslines. -## Heading 2 +## Heading 2 {: #heading-what-what } + +Caution: If you plan to link to specific headings +[``](#heading-what-what) within your document, it +is **strongly** recommended you define them yourself with the +`{: #anchor-name }` syntax. This ensures that when documents are localized, +the anchor will still work, but also ensures that any difference between +Markdown processors are a non-issue. ### Heading 3 @@ -267,10 +274,10 @@ Caution: This type of callout suggests proceeding with caution. Warning: This type of callout is stronger than a Caution; it means "Don't do this." -Success: This type of callout describes a successful action or an error-free status. Used only in interactive or dynamic content; don't use in ordinary static pages. +Success: This type of callout describes a successful action or an error-free status. -Dogfood: This type of callout is for notes that apply temporarily during internal dogfood testing. Remove all Dogfood callouts before making a document publicly visible. +Dogfood: This type of callout is for notes that apply temporarily during internal dogfood testing. ## Comparisons