From b8cef597026aac6fb3e6da3e41d3e162a566ea2a Mon Sep 17 00:00:00 2001 From: Matthias Felleisen Date: Mon, 18 Jun 2012 08:58:13 -0400 Subject: [PATCH] [Style] same names for same data in ADT implementations --- collects/scribblings/style/unit.scrbl | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/collects/scribblings/style/unit.scrbl b/collects/scribblings/style/unit.scrbl index 3311e3acbf..311eb8a0d3 100644 --- a/collects/scribblings/style/unit.scrbl +++ b/collects/scribblings/style/unit.scrbl @@ -282,11 +282,13 @@ Pick a rule for consistently naming your functions, classes, and Pick a rule for consistently naming and ordering the parameters of your functions and methods. Stick to it. For example, if your module implements an abstract data type (ADT), all functions on the ADT should consume the - ADT-argument first or last. Furthermore, if all of these functions accept - the same kind of information they should do so in the same position and - with the same name. See @filepath{collects/setup/scribble} and search for - occurrences of @racket[latex-dest]---they all refer to the same kind of - data. + ADT-argument first or last. + +Finally pick the same name for all function/method arguments in a module + that refer to the same kind of data---regardless of whether the module + implements a common data structure. For example, in + @filepath{collects/setup/scribble}, all functions use @racket[latex-dest] + to refer to the same kind of data, even those that are not exported. @subsection{Sections and Sub-modules}