Re: What does ^:internal mean?

2015-05-12 Thread Jakub Holy
You can use Symbol Hound to search for strange things though here it fails. Ex:

http://symbolhound.com/?q=-%3E%3E+clojure

On Sunday, May 10, 2015 at 9:00:10 PM UTC+2, piast...@gmail.com wrote:
 Sadly, Google seems to think I am search for internal when I search for 
 ^:internal so that makes it hard to find the documentation. I am curious 
 about this code:
 
 
 
 
 ;;; Capture the standard def forms' arglists
 (def ^:internal defn-arglists (vec (:arglists (meta #'defn
 (def ^:internal fn-arglists (vec (:arglists (meta #'fn
 (def ^:internal defmulti-arglists (vec (:arglists (meta #'defmulti
 (def ^:internal def-arglists '[[symbol doc-string? init?]])
 
 
 From here: 
 
 
 https://github.com/palletops/api-builder/blob/4d82355bec1ebdf7c501be71e2f3d156ae84ad2c/src/com/palletops/api_builder/impl.clj
 
 
 
 What does ^:internal mean in this context? 

-- 
You received this message because you are subscribed to the Google
Groups Clojure group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your 
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
--- 
You received this message because you are subscribed to the Google Groups 
Clojure group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to clojure+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Re: What does ^:internal mean?

2015-05-12 Thread Jakub Holy
You can use Symbol Hound to search for strange things though here it fails. Ex:

http://symbolhound.com/?q=-%3E%3E+clojure

On Sunday, May 10, 2015 at 9:00:10 PM UTC+2, piast...@gmail.com wrote:
 Sadly, Google seems to think I am search for internal when I search for 
 ^:internal so that makes it hard to find the documentation. I am curious 
 about this code:
 
 
 
 
 ;;; Capture the standard def forms' arglists
 (def ^:internal defn-arglists (vec (:arglists (meta #'defn
 (def ^:internal fn-arglists (vec (:arglists (meta #'fn
 (def ^:internal defmulti-arglists (vec (:arglists (meta #'defmulti
 (def ^:internal def-arglists '[[symbol doc-string? init?]])
 
 
 From here: 
 
 
 https://github.com/palletops/api-builder/blob/4d82355bec1ebdf7c501be71e2f3d156ae84ad2c/src/com/palletops/api_builder/impl.clj
 
 
 
 What does ^:internal mean in this context? 

-- 
You received this message because you are subscribed to the Google
Groups Clojure group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your 
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
--- 
You received this message because you are subscribed to the Google Groups 
Clojure group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to clojure+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Re: What does ^:internal mean?

2015-05-12 Thread Raoul Duke
knowing how to break down Clojure's syntax a bit helps, too. which
means newbies are kinda screwed until they divine this.

http://stackoverflow.com/questions/8920137/clojure-caret-as-a-symbol

-- 
You received this message because you are subscribed to the Google
Groups Clojure group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your 
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
--- 
You received this message because you are subscribed to the Google Groups 
Clojure group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to clojure+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Re: What does ^:internal mean?

2015-05-12 Thread Raoul Duke
even github gets it totally wrong, apparently?

https://github.com/laurentpetit/ccw/search?utf8=%E2%9C%93q=%22^%3Ainternal%22type=Code

because, you know, it isn't as if github is mostly all about hosting *code*.

such that, you know, you'd think they'd have realized by now this kind
of feature is desirable / the current functionality is a huge
lameness.

-- 
You received this message because you are subscribed to the Google
Groups Clojure group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your 
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
--- 
You received this message because you are subscribed to the Google Groups 
Clojure group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to clojure+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Re: What does ^:internal mean?

2015-05-12 Thread Andy Fingerhut
There are other sources for this information, too (perhaps better ones),
but the cheat sheet has a section with many of these special symbols:

clojure.org/cheatsheet

Andy

On Tue, May 12, 2015 at 1:49 PM, Raoul Duke rao...@gmail.com wrote:

 knowing how to break down Clojure's syntax a bit helps, too. which
 means newbies are kinda screwed until they divine this.

 http://stackoverflow.com/questions/8920137/clojure-caret-as-a-symbol

 --
 You received this message because you are subscribed to the Google
 Groups Clojure group.
 To post to this group, send email to clojure@googlegroups.com
 Note that posts from new members are moderated - please be patient with
 your first post.
 To unsubscribe from this group, send email to
 clojure+unsubscr...@googlegroups.com
 For more options, visit this group at
 http://groups.google.com/group/clojure?hl=en
 ---
 You received this message because you are subscribed to the Google Groups
 Clojure group.
 To unsubscribe from this group and stop receiving emails from it, send an
 email to clojure+unsubscr...@googlegroups.com.
 For more options, visit https://groups.google.com/d/optout.


-- 
You received this message because you are subscribed to the Google
Groups Clojure group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your 
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
--- 
You received this message because you are subscribed to the Google Groups 
Clojure group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to clojure+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Re: What does ^:internal mean?

2015-05-12 Thread David James
Re: Some people don't like the native approach to private vars since 
anyone who wants to override it can do so anyway, so they go with a purely 
conventional and unenforced approach: delineate the boundaries of API vs 
internal using :internal or :impl and/or put the internal bits in an impl 
namespace.

Yes. I've used this approach myself sometimes.

Function metadata can also enhance documentation generation. Functions with 
^:internal metadata could be treated and presented as internal API 
only. I don't know if codox or marginalia are customizable in this way.

On Monday, May 11, 2015 at 8:35:06 PM UTC-4, Mischov wrote:

 To answer your question, ^:internal is shorthand meaning set the 
 :internal key of the object's metadata to true.

 You can read more about metadata here http://clojure.org/metadata.

 On Sunday, May 10, 2015 at 2:00:10 PM UTC-5, piast...@gmail.com wrote:


 What does ^:internal mean in this context? 









-- 
You received this message because you are subscribed to the Google
Groups Clojure group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your 
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
--- 
You received this message because you are subscribed to the Google Groups 
Clojure group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to clojure+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Re: What does ^:internal mean?

2015-05-11 Thread Mischov
To answer your question, ^:internal is shorthand meaning set the :internal 
key of the object's metadata to true.

You can read more about metadata here http://clojure.org/metadata.

On Sunday, May 10, 2015 at 2:00:10 PM UTC-5, piast...@gmail.com wrote:


 What does ^:internal mean in this context? 









-- 
You received this message because you are subscribed to the Google
Groups Clojure group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your 
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
--- 
You received this message because you are subscribed to the Google Groups 
Clojure group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to clojure+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Re: What does ^:internal mean?

2015-05-10 Thread Robert Levy
Some people don't like the native approach to private vars since anyone who
wants to override it can do so anyway, so they go with a purely
conventional and unenforced approach: delineate the boundaries of API vs
internal using :internal or :impl and/or put the internal bits in an impl
namespace.  The origins of this are partly in the Joy of Clojure and partly
in Phil Hagelberg's code I believe.

On Sun, May 10, 2015 at 12:00 PM, piastkra...@gmail.com wrote:

 Sadly, Google seems to think I am search for internal when I search for
 ^:internal so that makes it hard to find the documentation. I am curious
 about this code:

 ;;; Capture the standard def forms' arglists
 (def ^:internal defn-arglists (vec (:arglists (meta #'defn
 (def ^:internal fn-arglists (vec (:arglists (meta #'fn
 (def ^:internal defmulti-arglists (vec (:arglists (meta #'defmulti
 (def ^:internal def-arglists '[[symbol doc-string? init?]])

 From here:


 https://github.com/palletops/api-builder/blob/4d82355bec1ebdf7c501be71e2f3d156ae84ad2c/src/com/palletops/api_builder/impl.clj

 What does ^:internal mean in this context?







  --
 You received this message because you are subscribed to the Google
 Groups Clojure group.
 To post to this group, send email to clojure@googlegroups.com
 Note that posts from new members are moderated - please be patient with
 your first post.
 To unsubscribe from this group, send email to
 clojure+unsubscr...@googlegroups.com
 For more options, visit this group at
 http://groups.google.com/group/clojure?hl=en
 ---
 You received this message because you are subscribed to the Google Groups
 Clojure group.
 To unsubscribe from this group and stop receiving emails from it, send an
 email to clojure+unsubscr...@googlegroups.com.
 For more options, visit https://groups.google.com/d/optout.


-- 
You received this message because you are subscribed to the Google
Groups Clojure group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your 
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
--- 
You received this message because you are subscribed to the Google Groups 
Clojure group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to clojure+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


What does ^:internal mean?

2015-05-10 Thread piastkrakow
Sadly, Google seems to think I am search for internal when I search for 
^:internal so that makes it hard to find the documentation. I am curious 
about this code:

;;; Capture the standard def forms' arglists
(def ^:internal defn-arglists (vec (:arglists (meta #'defn
(def ^:internal fn-arglists (vec (:arglists (meta #'fn
(def ^:internal defmulti-arglists (vec (:arglists (meta #'defmulti
(def ^:internal def-arglists '[[symbol doc-string? init?]])

From here: 

https://github.com/palletops/api-builder/blob/4d82355bec1ebdf7c501be71e2f3d156ae84ad2c/src/com/palletops/api_builder/impl.clj

What does ^:internal mean in this context? 







-- 
You received this message because you are subscribed to the Google
Groups Clojure group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your 
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
--- 
You received this message because you are subscribed to the Google Groups 
Clojure group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to clojure+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Re: What does ^:internal mean?

2015-05-10 Thread Andy Fingerhut
I am pretty sure that there is nothing in the Clojure compiler that pays
attention to the key :internal in metadata.

People can put whatever metadata they want anywhere they wish, even if the
Clojure compiler ignores it.  This looks like some metadata specific to
pallet, but not sure whether it uses it for anything other than for the
purposes of a hint to people reading the code.  Hopefully someone more
knowledgeable about pallet will correct that guess if it is wrong.

Andy

On Sun, May 10, 2015 at 12:00 PM, piastkra...@gmail.com wrote:

 Sadly, Google seems to think I am search for internal when I search for
 ^:internal so that makes it hard to find the documentation. I am curious
 about this code:

 ;;; Capture the standard def forms' arglists
 (def ^:internal defn-arglists (vec (:arglists (meta #'defn
 (def ^:internal fn-arglists (vec (:arglists (meta #'fn
 (def ^:internal defmulti-arglists (vec (:arglists (meta #'defmulti
 (def ^:internal def-arglists '[[symbol doc-string? init?]])

 From here:


 https://github.com/palletops/api-builder/blob/4d82355bec1ebdf7c501be71e2f3d156ae84ad2c/src/com/palletops/api_builder/impl.clj

 What does ^:internal mean in this context?







  --
 You received this message because you are subscribed to the Google
 Groups Clojure group.
 To post to this group, send email to clojure@googlegroups.com
 Note that posts from new members are moderated - please be patient with
 your first post.
 To unsubscribe from this group, send email to
 clojure+unsubscr...@googlegroups.com
 For more options, visit this group at
 http://groups.google.com/group/clojure?hl=en
 ---
 You received this message because you are subscribed to the Google Groups
 Clojure group.
 To unsubscribe from this group and stop receiving emails from it, send an
 email to clojure+unsubscr...@googlegroups.com.
 For more options, visit https://groups.google.com/d/optout.


-- 
You received this message because you are subscribed to the Google
Groups Clojure group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your 
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
--- 
You received this message because you are subscribed to the Google Groups 
Clojure group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to clojure+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.