From f1faf3965d32bd47db012ff108a94c4d555cf96a Mon Sep 17 00:00:00 2001 From: Andrew Henry Date: Sat, 16 May 2020 16:07:49 -0700 Subject: [PATCH] Changed reference to `constructors` to `classes` --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9febd0dfaf..8d091b00fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -130,7 +130,7 @@ this repository. This is verified by the command line build. JavaScript sources in Open MCT should: 1. Write clean code. Here’s a good summary - https://github.com/ryanmcdermott/clean-code-javascript. -1. Include JSDoc for any exposed API (e.g. public methods, constructors). +1. Include JSDoc for any exposed API (e.g. public methods, classes). 1. Include non-JSDoc comments as-needed for explaining private variables, methods, or algorithms when they are non-obvious. Otherwise code should be self-documenting.