Commit6e76411

authored

Merge pull request#18046 from QuLogic/doc-link-headers

Discourage references in section headings.

2 parents7647550 +177d055 commit6e76411Copy full SHA for 6e76411

File tree

-2

lines changed

-2

lines changed

Lines changed: 3 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,9 @@ author's initials. Typically, each change will get its own file, but you may`
`22`	`22`	`also amend existing files when suitable. The overall goal is a comprehensible`
`23`	`23`	`documentation of the changes.`
`24`	`24`
`25`		`-A typical entry could look like this::`
	`25`	`+Please avoid using references in section titles, as it causes links to be`
	`26`	`+confusing in the table of contents. Instead, ensure that a reference is`
	`27`	`+included in the descriptive text. A typical entry could look like this::`
`26`	`28`
`27`	`29`	`Locators`
`28`	`30`	`~~~~~~~~`

Lines changed: 5 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,11 @@ When adding an entry please look at the currently existing files to`
`9`	`9`	`see if you can extend any of them. If you create a file, name it`
`10`	`10`	something like:file:`cool_new_feature.rst` if you have added a brand new
`11`	`11`	feature or something like:file:`updated_feature.rst` for extensions of
`12`		`-existing features. Include contents of the form: ::`
	`12`	`+existing features.`
	`13`	`+`
	`14`	`+Please avoid using references in section titles, as it causes links to be`
	`15`	`+confusing in the table of contents. Instead, ensure that a reference is`
	`16`	`+included in the descriptive text. Include contents of the form: ::`
`13`	`17`
`14`	`18`	`Section Title for Feature`
`15`	`19`	`-------------------------`

Comments

(0)