From d810653b63b29ff4536a8d691dc397b6ba4761e4 Mon Sep 17 00:00:00 2001 From: Andy Port Date: Fri, 2 Nov 2018 16:42:11 -0700 Subject: [PATCH] minor improvements --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7ea1bc7..3a8b059 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,8 +42,9 @@ you want your code's variable names to match some official documentation, or PEP8 guidelines contradict those present in this document). * Include docstrings and in-line comments where appropriate. See "Docstring Style" section below for more info. -* Use explicit, uncontracted names (e.g. "parse_transform" instead of -"parse_trafo"). The ideal names should be something a user can guess +* Use explicit, uncontracted names (e.g. `parse_transform` instead of +`parse_trafo`). Maybe the most important feature for a name is how easy it is +for a user to guess (after having seen other names used in `svgpathtools`). * Use a capital 'T' denote a Path object's parameter, use a lower case 't' to denote a Path segment's parameter. See the methods `Path.t2T` and `Path.T2t` if you're unsure what I mean. In the ambiguous case, use either 't' or another