From 9b1d1dc2c7cfd818af1f1b602b271851a1c7f998 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Tue, 12 Jul 2016 22:00:28 -0700 Subject: [PATCH] clarify rules for documenting classes --- docs/styleguide.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/styleguide.md b/docs/styleguide.md index ba7d707fd89f..742e4e28a3d3 100644 --- a/docs/styleguide.md +++ b/docs/styleguide.md @@ -96,10 +96,11 @@ Using `autoUpdater` as an example: * API classes or classes that are part of modules must be listed under a `## Class: TheClassName` chapter. * One page can have multiple classes. -* The constructors must be listed with `###`-level titles. -* The methods must be listed under an `### Instance Methods` chapter. -* The events must be listed under an `### Instance Events` chapter. -* The properties must be listed under an `### Instance Properties` chapter. +* Constructors must be listed with `###`-level titles. +* [Static Methods](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/static) must be listed under a `### Static Methods` chapter. +* [Instance Methods](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes#Prototype_methods) must be listed under an `### Instance Methods` chapter. +* Instance Events must be listed under an `### Instance Events` chapter. +* Instance Properties must be listed under an `### Instance Properties` chapter. Using the `Session` and `Cookies` classes as an example: