Comments (2)
Is there an intentional reason that &keys
has been omitted from the function documentation? If not, I'm happy to put together a PR for review - assuming that I understand the feature correctly. My understanding:
# Any arguments following the function's required arguments are
# gathered into a struct and bound to the symbol following &keys.
((fn [&keys k] k)) # => {}
((fn [x y z &keys k] k) 1 2 3 :x 1 :y 2 :z 3) # => {:x 1 :y 2 :z 3}
# This combination of &keys and a symbol must be the last entry in the parameter tuple.
(fn [&keys k x]) # => compile error: &keys in unexpected location
# The compiler will not allow the simultaneous use of & and &keys.
(fn [& &keys k]) # => compile error: & in unexpected location
# The compiler will allow &opt to precede &keys, but in doing so all
# optional parameters become non-optional.
((fn [&opt o &keys k] [o k]) :x 1 :y 2) # => [:x {1 :y}]
((fn [&opt o &keys k] [o k]) 'shrug :x 1 :y 2) # => [shrug {:x 1 :y 2}]
# If any of the keyword arguments contain duplicate keys, the first
# occurrence of the key is used.
((fn [&keys k] k) :x 1 :x 2 :x 3) # => {:x 1}
# Example usage
(defn greet
[name &keys {:greeting greeting}]
(let [greeting (or greeting "Hello")]
(print greeting ", " name "!")))
(greet "Janet") # => prints: Hello, Janet!
(greet "Janet" :greeting "Good morning") # => prints: Good morning, Janet!
from janet-lang.org.
No reason, just it was added after the original documentation was written. Please do!
from janet-lang.org.
Related Issues (20)
- Embedding section incomplete? HOT 3
- Update first paragraph of jpm page HOT 1
- Multithreading section still refers to `thread/` functions despite deprecation HOT 7
- On event_loop page, "raises and error" may be typoed - "raises an error"? HOT 2
- `%c` format specifier is not documented with its friends HOT 3
- Link to Joy 404s HOT 4
- Move "The Event Loop" before "Multithreading" in table of contents HOT 3
- HTTP Status 403 for `assets/favicon.ico:1` HOT 3
- Update destructuring docs with `& more` HOT 2
- No function to convert double -> binary representation HOT 3
- Document on emscripten outdated HOT 3
- Auto-focusing search means you can't link to specific API functions HOT 1
- Example in "Installing a module" points at archived repository
- PEG specials `true` and `false` lack docs on PEG page HOT 2
- Related Windows instructions out-of-sync
- Bytecode reference table lacks entry for divf HOT 1
- Several (probably all) community examples links of spork functions are broken. HOT 9
- Bytecode reference table lacks entry for subim
- Non-ideal discoverability of Janet divergences from other programming languages HOT 9
- Extra dots in some operator symbols in ref table for abstract machine instructions?
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 janet-lang.org.