From c50166fd20aa19e46f474dc7399a5a8aead15d4b Mon Sep 17 00:00:00 2001 From: Siraaj Khandkar Date: Tue, 6 Jan 2015 21:12:48 -0500 Subject: [PATCH] Note low (anonymous) argument count in conventions --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index d9b4464..5f2ed6c 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,16 @@ else, these are influenced by Jane Street's Core of the OCaml world. - Names of public records _must_ be fully qualified, such as: `#hope_module_record{}` - Names of all modules _must_ be fully qualified, such as: `hope_module` (this should go without saying, but just to be sure...) +- Keep the number of (anonymous) arguments "reasonably" low: + + up to 3 is normal + + 4 is suspicious but may be reasonable + + 5 is _very_ suspicious and probably unnecessary + + more than 5 is unacceptable, so consider reducing by: + 1. revising abstractions, or, if not practical + 2. creating a public record specifically for the purpose of passing + many arguents, which simulates labeled arguments. For an example see + https://github.com/ibnfirnas/oauth1_core where I used that technique + extensively (especially in oauth1_server.erl) Abstractions -- 2.20.1