Comments (3)
It depends. Make the function arguments self-documenting for the caller. If the argument is best understood as a viewer
, the arglists should show that. I would use:
;;; Good: let binding inside function
(defn distance-to-unit
[viewer dim value]
(let [{:keys [scale units-per-pixel]} viewer]
...))
;;; Also good: Fix the arglists.
(defn distance-to-unit
{:arglists '([viewer dim value])}
[{:keys [scale units-per-pixel]} dim value]
...)
In the case of "options", I would do the destructuring in the function definition (and not alter the arglists) so that the keys show up in the function documentation automatically.
from clojure-style-guide.
@ToBeReplaced i like the approach you provided with let. Definition is cleaner and you don't spread parameters definitions among multiple blocks.
Notice also that when you destructure parameters in function definition - you specify some kind of implicit protocol. You can say from it what keys should input arguments contain.
from clojure-style-guide.
+1 for @ToBeReplaced suggestion for clear arguments.
from clojure-style-guide.
Related Issues (20)
- Use keys of different length in let & map alignment example HOT 1
- Consider adding :no-doc under common metadata HOT 2
- Consider talking about defprotocol and deftype a bit more? HOT 2
- Multimethod Dispatch Val Placement advice impractical with docstring or attr-map HOT 2
- Clarify `if` indentation HOT 3
- Improve title HOT 2
- Consider updating/removing suggestions about complement, partial and comp HOT 6
- x, y - numbers -- only if x and y appear together? HOT 1
- Add note about preferring `(if-not (= ...))` over `(if (not= ...))` and `(when-not (= ...))` over `(when (not= ...))` HOT 8
- Add section about Yoda conditions HOT 1
- No guidance on function arguments naming? HOT 1
- Add note about putting then and else forms on separate lines in `if` HOT 3
- cond-> and cond->> :always test expression HOT 6
- Idiomatic namespace alias for clojure.spec.alpha should be `s` instead of `spec` HOT 5
- Clarify `ns` form rules HOT 3
- The link to "The Joy of Clojure" is dead. HOT 4
- The link to "Clojure Programming" is dead HOT 1
- Italian translation HOT 1
- Threading macro alignment of first argument on it's own line HOT 2
- Test naming inconsist with function naming. HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from clojure-style-guide.