expanding the list to include things like ‘..’

There’s a brief mention of .. syntax in the manual, 
http://docs.julialang.org/en/latest/manual/modules/#relative-and-absolute-module-paths,
 
but adding something about it
to the docstring for using or import would probably be worth doing.

and -> are in the list

Presumably you’d want help?> -> to display some docs? If so then they would 
need to be added to 
https://github.com/JuliaLang/julia/blob/master/base/docs/basedocs.jl in the 
same manner as the keywords in that file are documented, something like:

keywords[:->] = doc"""
    (args...) -> ...

`->` is syntax used to declare an anonymous function.
"""

The docs for using and import are also in that same file if you’re wanting 
to add details about .. to those.

coming up with a brief synopsis for all

Most objects that aren’t documented have some very basic automatically 
generated summary info, but could always use improvement if you’ve got 
ideas.

— Mike
​
On Thursday, 24 September 2015 13:07:54 UTC+2, Alex Copeland wrote:
>
> Thank you.  I struggled a bit with how to phrase my question. 'operator', 
> it turns out wasn't the best choice. Maybe symbols would have been better? 
>
> A table of operators and other symbols would be very useful. Maybe a good 
> project for a newbie like myself. 
>
> To leave something in this thread which might be useful for future 
> searchers, I'll briefly mention that I discovered julia's help mode, if fed 
> an empty tab complete, prints a huge list of items including a long list of 
> symbols (unicode too) with documentation.   The list isn't complete, 
> though, as neither '..' and '->' are in the list, and some have missing 
> documentation. 
>
> Providing aliases for some of the unicode items, expanding the list to 
> include things like '..',  and coming up with a brief synopsis for all 
> might be even better project for me than constructing a table of operators. 
> I'll start a new thread if I get anywhere with this.
>
>
> help?> ⊈
> search: ⊈
>
>   No documentation found.
>
>   Base.⊈ is a generic Function.
>
>   # 1 method for generic function "⊈":
>   ⊈(l::Set{T}, r::Set{T}) at set.jl:104
>
>
>
>
> On Wednesday, September 23, 2015 at 5:07:06 PM UTC-7, Erik Schnetter wrote:
>>
>> Yes, operators are difficult to search for. There should be a table of 
>> them...
>>
>> The two dots .. are not an operator; they specify an access path to a 
>> module. See <http://docs.julialang.org/en/release-0.3/manual/modules/>
>>
>> The arrow -> defines an anonymous function. See <
>> http://docs.julialang.org/en/release-0.3/manual/functions/>. Here, this 
>> function accesses the second element of an array (or tuple or other 
>> collection).
>>
>> -erik
>>
>> On Wed, Sep 23, 2015 at 7:47 PM, Alex Copeland <accop...@lbl.gov> wrote:
>>
>>> Update from OP: Not sure it matters, but on the off chance the syntax is 
>>> new,  I'm running
>>>
>>> julia> versioninfo()
>>> Julia Version 0.5.0-dev+318
>>> Commit 3b189b9* (2015-09-22 15:28 UTC)
>>> Platform Info:
>>>   System: Darwin (x86_64-apple-darwin12.4.0)
>>>   CPU: Intel(R) Core(TM) i7-3520M CPU @ 2.90GHz
>>>   WORD_SIZE: 64
>>>   BLAS: libopenblas (DYNAMIC_ARCH NO_AFFINITY Sandybridge)
>>>   LAPACK: libopenblas
>>>   LIBM: libopenlibm
>>>   LLVM: libLLVM-3.3
>>>
>>>
>>>
>>> On Wednesday, September 23, 2015 at 3:32:57 PM UTC-7, Alex Copeland 
>>> wrote:
>>>>
>>>>
>>>>
>>>> Hi,
>>>>
>>>> Can someone point me to the documentation for '..'  and '->'  as in 
>>>>  'include ..Sort'  and x -> x[2] . I've dug around in the source and in 
>>>> readthedocs but patterns like this are the devil to search for unless they 
>>>> have a text alias (that you happen to know). 
>>>>
>>>> Thanks,
>>>> Alex
>>>>
>>>
>>
>>
>> -- 
>> Erik Schnetter <schn...@gmail.com> 
>> http://www.perimeterinstitute.ca/personal/eschnetter/
>>
>

Reply via email to