github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-04-10 03:01:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

chore: disallow shortcut reference links in docs Markdown (#36860)

Browse Source 
* chore: disallow shortcut reference links in docs Markdown

* docs: clean up shortcut-style links
This commit is contained in:
David Sanders
2023-01-16 01:22:49 -08:00
committed by GitHub
parent a9e7bb0027
commit d94f35a8f6
38 changed files with 199 additions and 171 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/styleguide.md
View File

@@ -113,13 +113,13 @@ Using `autoUpdater` as an example:
* [Instance Methods](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes#Prototype_methods)
must be listed under an `### Instance Methods` chapter.
* All methods that have a return value must start their description with
"Returns `[TYPE]` - [Return description]"
"Returns `[TYPE]` - \[Return description]"
* If the method returns an `Object`, its structure can be specified using a colon
followed by a newline then an unordered list of properties in the same style as
function parameters.
* Instance Events must be listed under an `### Instance Events` chapter.
* Instance Properties must be listed under an `### Instance Properties` chapter.
* Instance Properties must start with "A [Property Type] ..."
* Instance Properties must start with "A \[Property Type] ..."
Using the `Session` and `Cookies` classes as an example: