Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

complete documentation for 1.0 release #48

Closed
StefanKarpinski opened this issue Jun 15, 2011 · 9 comments
Closed

complete documentation for 1.0 release #48

StefanKarpinski opened this issue Jun 15, 2011 · 9 comments
Assignees
@StefanKarpinski
Labels
domain:docs This change adds or pertains to documentation
Milestone
0.1

Comments

@StefanKarpinski
Copy link
Sponsor Member

[edit: see Stefan's list below for bulleted list]

This includes:

These are all necessary for the v1.0 release.
@ghost ghost assigned StefanKarpinski Jun 15, 2011
@ViralBShah
Copy link
Member

We may need some function-wise documentation also for 1.0. The function reference can just stay on the wiki for now. If deemed useful, we can make it accessible within julia as well.

I still prefer using the matlab help command over anything else.

@JeffBezanson
Copy link
Sponsor Member

We can start filing issues on specific things that need to be documented. Every now and then I recall some interesting or important feature of julia that I don't think has been documented. I created a "doc" label for such things.

@JeffBezanson
Copy link
Sponsor Member

Let me know if there are any sections of the docs I should write or help with.

@StefanKarpinski
Copy link
Sponsor Member Author

I just started on Conversion and Promotion. The obvious gaping hole is Arrays, which is a pretty big and important topic. The other thing that it would be great to have more complete documentation of is Parallel Computing. What's there so far is great, but the last few sections are still blank.

@StefanKarpinski
Copy link
Sponsor Member Author

Here are the final remaining TODOs:

  • better and more examples in regular expressions
  • take another pass over function, add section on tuples
  • arrays
  • reading and writing from external programs
  • reflection in metaprogramming
  • complete parallel computing

@JeffBezanson
Copy link
Sponsor Member

Need to document reading the output of external processes.

@ViralBShah
Copy link
Member

Don't we have enough documentation for 1.0? Can we close this one?

@StefanKarpinski
Copy link
Sponsor Member Author

Actually, at this point the documentation needs quite a lot of refreshing. I can take a pass through before we release 1.0, probably as one of the last things we do, and make sure that everything is accurate, complete, and current.

@ViralBShah ViralBShah mentioned this issue Mar 19, 2012
Merged
@StefanKarpinski
Copy link
Sponsor Member Author

I'm closing this because it's obvious.

StefanKarpinski pushed a commit that referenced this issue Feb 8, 2018
@oxinabox @staticfloat
=Use abstract type, not union (#48)
ad95112
@vchuravy vchuravy mentioned this issue Feb 8, 2018
Closed
Keno added a commit that referenced this issue Jan 25, 2019
@Keno
Fix showing method candidates for invoke-style MethodError
67776c9 
Fixes the following issue:
```
julia> invoke(sin, Tuple{NoMethodsDefinedHere}, NoMethodsDefinedHere())
ERROR: ┌ Error: Error showing method candidates, aborted
│   exception =
│    MethodError: no method matching length(::Type{Tuple{NoMethodsDefinedHere}})
│    Closest candidates are:
│      length(::Core.SimpleVector) at essentials.jl:582
│      length(::Base.MethodList) at reflection.jl:732
│      length(::Core.MethodTable) at reflection.jl:806
│      ...
│    Stacktrace:
│     [1] show_method_candidates(::IOContext{Base.GenericIOBuffer{Array{UInt8,1}}}, ::MethodError, ::Any) at ./errorshow.jl:387
│     [2] showerror(::IOContext{Base.GenericIOBuffer{Array{UInt8,1}}}, ::MethodError) at ./errorshow.jl:255
│     [3] (::getfield(Base, Symbol("##613#614")){MethodError})(::IOContext{Base.GenericIOBuffer{Array{UInt8,1}}}) at ./errorshow.jl:76
│     [4] #with_output_color#660(::Bool, ::Function, ::Function, ::Symbol, ::IOContext{REPL.Terminals.TTYTerminal}) at ./util.jl:366
│     [5] with_output_color(::Function, ::Symbol, ::IOContext{REPL.Terminals.TTYTerminal}) at ./util.jl:364
│     [6] #showerror#612(::Bool, ::Function, ::IOContext{REPL.Terminals.TTYTerminal}, ::MethodError, ::Array{Union{Ptr{Nothing}, InterpreterIP},1}) at ./errorshow.jl:75
│     [7] showerror at ./errorshow.jl:74 [inlined]
│     [8] display_error(::IOContext{REPL.Terminals.TTYTerminal}, ::MethodError, ::Array{Union{Ptr{Nothing}, InterpreterIP},1}) at ./client.jl:99
│     [9] #invokelatest#1 at ./essentials.jl:697 [inlined]
│     [10] invokelatest at ./essentials.jl:696 [inlined]
│     [11] print_response(::IO, ::Any, ::Any, ::Bool, ::Bool, ::Any) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/REPL.jl:149
│     [12] print_response(::REPL.AbstractREPL, ::Any, ::Any, ::Bool, ::Bool) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/REPL.jl:140
│     [13] (::getfield(REPL, Symbol("#do_respond#38")){Bool,getfield(REPL, Symbol("##48#57")){REPL.LineEditREPL,REPL.REPLHistoryProvider},REPL.LineEditREPL,REPL.LineEdit.Prompt})(::Any, ::Any, ::Any) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/REPL.jl:714
│     [14] #invokelatest#1 at ./essentials.jl:697 [inlined]
│     [15] invokelatest at ./essentials.jl:696 [inlined]
│     [16] run_interface(::REPL.Terminals.TextTerminal, ::REPL.LineEdit.ModalInterface, ::REPL.LineEdit.MIState) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/LineEdit.jl:2268
│     [17] run_frontend(::REPL.LineEditREPL, ::REPL.REPLBackendRef) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/REPL.jl:1035
│     [18] run_repl(::REPL.AbstractREPL, ::Any) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/REPL.jl:192
│     [19] (::getfield(Base, Symbol("##723#725")){Bool,Bool,Bool,Bool})(::Module) at ./logging.jl:311
│     [20] #invokelatest#1 at ./essentials.jl:697 [inlined]
│     [21] invokelatest at ./essentials.jl:696 [inlined]
│     [22] macro expansion at ./logging.jl:308 [inlined]
│     [23] run_main_repl(::Bool, ::Bool, ::Bool, ::Bool, ::Bool) at ./client.jl:330
│     [24] exec_options(::Base.JLOptions) at ./client.jl:242
│     [25] _start() at ./client.jl:421
└ @ Base errorshow.jl:257
MethodError: no method matching sin(::NoMethodsDefinedHere)
Stacktrace:
 [1] top-level scope at none:0
```
Keno added a commit that referenced this issue Jan 25, 2019
@Keno
Fix showing method candidates for invoke-style MethodError
850b56b 
Fixes the following issue:
```
julia> invoke(sin, Tuple{NoMethodsDefinedHere}, NoMethodsDefinedHere())
ERROR: ┌ Error: Error showing method candidates, aborted
│   exception =
│    MethodError: no method matching length(::Type{Tuple{NoMethodsDefinedHere}})
│    Closest candidates are:
│      length(::Core.SimpleVector) at essentials.jl:582
│      length(::Base.MethodList) at reflection.jl:732
│      length(::Core.MethodTable) at reflection.jl:806
│      ...
│    Stacktrace:
│     [1] show_method_candidates(::IOContext{Base.GenericIOBuffer{Array{UInt8,1}}}, ::MethodError, ::Any) at ./errorshow.jl:387
│     [2] showerror(::IOContext{Base.GenericIOBuffer{Array{UInt8,1}}}, ::MethodError) at ./errorshow.jl:255
│     [3] (::getfield(Base, Symbol("##613#614")){MethodError})(::IOContext{Base.GenericIOBuffer{Array{UInt8,1}}}) at ./errorshow.jl:76
│     [4] #with_output_color#660(::Bool, ::Function, ::Function, ::Symbol, ::IOContext{REPL.Terminals.TTYTerminal}) at ./util.jl:366
│     [5] with_output_color(::Function, ::Symbol, ::IOContext{REPL.Terminals.TTYTerminal}) at ./util.jl:364
│     [6] #showerror#612(::Bool, ::Function, ::IOContext{REPL.Terminals.TTYTerminal}, ::MethodError, ::Array{Union{Ptr{Nothing}, InterpreterIP},1}) at ./errorshow.jl:75
│     [7] showerror at ./errorshow.jl:74 [inlined]
│     [8] display_error(::IOContext{REPL.Terminals.TTYTerminal}, ::MethodError, ::Array{Union{Ptr{Nothing}, InterpreterIP},1}) at ./client.jl:99
│     [9] #invokelatest#1 at ./essentials.jl:697 [inlined]
│     [10] invokelatest at ./essentials.jl:696 [inlined]
│     [11] print_response(::IO, ::Any, ::Any, ::Bool, ::Bool, ::Any) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/REPL.jl:149
│     [12] print_response(::REPL.AbstractREPL, ::Any, ::Any, ::Bool, ::Bool) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/REPL.jl:140
│     [13] (::getfield(REPL, Symbol("#do_respond#38")){Bool,getfield(REPL, Symbol("##48#57")){REPL.LineEditREPL,REPL.REPLHistoryProvider},REPL.LineEditREPL,REPL.LineEdit.Prompt})(::Any, ::Any, ::Any) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/REPL.jl:714
│     [14] #invokelatest#1 at ./essentials.jl:697 [inlined]
│     [15] invokelatest at ./essentials.jl:696 [inlined]
│     [16] run_interface(::REPL.Terminals.TextTerminal, ::REPL.LineEdit.ModalInterface, ::REPL.LineEdit.MIState) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/LineEdit.jl:2268
│     [17] run_frontend(::REPL.LineEditREPL, ::REPL.REPLBackendRef) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/REPL.jl:1035
│     [18] run_repl(::REPL.AbstractREPL, ::Any) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/REPL.jl:192
│     [19] (::getfield(Base, Symbol("##723#725")){Bool,Bool,Bool,Bool})(::Module) at ./logging.jl:311
│     [20] #invokelatest#1 at ./essentials.jl:697 [inlined]
│     [21] invokelatest at ./essentials.jl:696 [inlined]
│     [22] macro expansion at ./logging.jl:308 [inlined]
│     [23] run_main_repl(::Bool, ::Bool, ::Bool, ::Bool, ::Bool) at ./client.jl:330
│     [24] exec_options(::Base.JLOptions) at ./client.jl:242
│     [25] _start() at ./client.jl:421
└ @ Base errorshow.jl:257
MethodError: no method matching sin(::NoMethodsDefinedHere)
Stacktrace:
 [1] top-level scope at none:0
```
Keno added a commit that referenced this issue Jan 28, 2019
@Keno
Fix showing method candidates for invoke-style MethodError
bde465a 
Fixes the following issue:
```
julia> invoke(sin, Tuple{NoMethodsDefinedHere}, NoMethodsDefinedHere())
ERROR: ┌ Error: Error showing method candidates, aborted
│   exception =
│    MethodError: no method matching length(::Type{Tuple{NoMethodsDefinedHere}})
│    Closest candidates are:
│      length(::Core.SimpleVector) at essentials.jl:582
│      length(::Base.MethodList) at reflection.jl:732
│      length(::Core.MethodTable) at reflection.jl:806
│      ...
│    Stacktrace:
│     [1] show_method_candidates(::IOContext{Base.GenericIOBuffer{Array{UInt8,1}}}, ::MethodError, ::Any) at ./errorshow.jl:387
│     [2] showerror(::IOContext{Base.GenericIOBuffer{Array{UInt8,1}}}, ::MethodError) at ./errorshow.jl:255
│     [3] (::getfield(Base, Symbol("##613#614")){MethodError})(::IOContext{Base.GenericIOBuffer{Array{UInt8,1}}}) at ./errorshow.jl:76
│     [4] #with_output_color#660(::Bool, ::Function, ::Function, ::Symbol, ::IOContext{REPL.Terminals.TTYTerminal}) at ./util.jl:366
│     [5] with_output_color(::Function, ::Symbol, ::IOContext{REPL.Terminals.TTYTerminal}) at ./util.jl:364
│     [6] #showerror#612(::Bool, ::Function, ::IOContext{REPL.Terminals.TTYTerminal}, ::MethodError, ::Array{Union{Ptr{Nothing}, InterpreterIP},1}) at ./errorshow.jl:75
│     [7] showerror at ./errorshow.jl:74 [inlined]
│     [8] display_error(::IOContext{REPL.Terminals.TTYTerminal}, ::MethodError, ::Array{Union{Ptr{Nothing}, InterpreterIP},1}) at ./client.jl:99
│     [9] #invokelatest#1 at ./essentials.jl:697 [inlined]
│     [10] invokelatest at ./essentials.jl:696 [inlined]
│     [11] print_response(::IO, ::Any, ::Any, ::Bool, ::Bool, ::Any) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/REPL.jl:149
│     [12] print_response(::REPL.AbstractREPL, ::Any, ::Any, ::Bool, ::Bool) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/REPL.jl:140
│     [13] (::getfield(REPL, Symbol("#do_respond#38")){Bool,getfield(REPL, Symbol("##48#57")){REPL.LineEditREPL,REPL.REPLHistoryProvider},REPL.LineEditREPL,REPL.LineEdit.Prompt})(::Any, ::Any, ::Any) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/REPL.jl:714
│     [14] #invokelatest#1 at ./essentials.jl:697 [inlined]
│     [15] invokelatest at ./essentials.jl:696 [inlined]
│     [16] run_interface(::REPL.Terminals.TextTerminal, ::REPL.LineEdit.ModalInterface, ::REPL.LineEdit.MIState) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/LineEdit.jl:2268
│     [17] run_frontend(::REPL.LineEditREPL, ::REPL.REPLBackendRef) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/REPL.jl:1035
│     [18] run_repl(::REPL.AbstractREPL, ::Any) at /home/keno/julia-1.0/usr/share/julia/stdlib/v1.1/REPL/src/REPL.jl:192
│     [19] (::getfield(Base, Symbol("##723#725")){Bool,Bool,Bool,Bool})(::Module) at ./logging.jl:311
│     [20] #invokelatest#1 at ./essentials.jl:697 [inlined]
│     [21] invokelatest at ./essentials.jl:696 [inlined]
│     [22] macro expansion at ./logging.jl:308 [inlined]
│     [23] run_main_repl(::Bool, ::Bool, ::Bool, ::Bool, ::Bool) at ./client.jl:330
│     [24] exec_options(::Base.JLOptions) at ./client.jl:242
│     [25] _start() at ./client.jl:421
└ @ Base errorshow.jl:257
MethodError: no method matching sin(::NoMethodsDefinedHere)
Stacktrace:
 [1] top-level scope at none:0
```
cmcaine pushed a commit to cmcaine/julia that referenced this issue Sep 24, 2020
@SaschaMann
Merge pull request JuliaLang#48 from alemelis/julia-logo
aa30fdd 
Add: logo files
@brett-mahar brett-mahar mentioned this issue Aug 9, 2021
Closed
LilithHafner pushed a commit to LilithHafner/julia that referenced this issue Oct 11, 2021
@garborg
Merge pull request JuliaLang#48 from curiousleo/patch-1
7a6769e 
Typo in README.md
@chflood chflood mentioned this issue Mar 9, 2022
Closed
Keno pushed a commit that referenced this issue Oct 9, 2023
@timholy
Merge pull request #48 from JuliaDebug/teh/docexprs
8038678 
Fix and test docstring extraction
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@StefanKarpinski StefanKarpinski

Labels
domain:docs This change adds or pertains to documentation
Projects
None yet
Milestone
0.1
Development

No branches or pull requests
3 participants
@StefanKarpinski @ViralBShah @JeffBezanson