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.

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

[release-0.4] backports for RC2 #13182

Merged
merged 24 commits into from
Sep 18, 2015
Merged
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
0dd43a7
fix tracking of serialization state for Function types
amitmurthy Sep 15, 2015
02a885d
added tests [ci skip]
amitmurthy Sep 16, 2015
abba461
fix serializing functions with cycles, and a bug in serializing Expr
JeffBezanson Sep 16, 2015
2b69ef6
Constify deprecated bindings
tkelman Sep 17, 2015
dcd7ffc
Minor doc fix.
GlenHertz Sep 16, 2015
fc83771
Fix #13175, segfault with 👻 fields
simonster Sep 17, 2015
fcc4eb7
handle passing of Ref{GhostType} to cfunction signature (fix #13031)
vtjnash Sep 16, 2015
a6cf1d3
Makefile src/libccalltest needs to depend on julia-deps target
vtjnash Sep 16, 2015
73e132c
remove leading heisenzero from grisu output (fix #12899, fix #10908, …
vtjnash Sep 17, 2015
a89c40c
Doc: note convention for upper-case Module names
mbauman Sep 17, 2015
f7e3590
Doc: simple typo fix
mbauman Sep 17, 2015
79ffcb6
DOC: missing ncv optional argument in eigs
mzaffalon Sep 17, 2015
18d1507
Improving documentation typo
omus Sep 17, 2015
2ad9701
fix #13183, infinite recursion in compiler via static parameter
JeffBezanson Sep 17, 2015
3596965
basedocs: abstract, bitstype, module, baremodule, macro
catawbasam Sep 17, 2015
2b71231
Fix compiler warning about incompatible pointer types. jl_fptr_t is a…
yuyichao Sep 17, 2015
0c3dd77
fix missing `io` argument to `println` in umfpack
JeffBezanson Sep 17, 2015
f972e6a
add deprecation for Union()
JeffBezanson Sep 17, 2015
efe88f3
Grouped docstrings for FFTW in an if USE_GPL_LIBS block
nkottary Sep 14, 2015
abcc5fb
Moved fft docstrings from helpdb.jl to appropriate files in base/fft/
nkottary Sep 14, 2015
da6e9fa
Moved docstrings for *fft* functions from helpdb.jl to base/dft.jl an…
nkottary Sep 15, 2015
6457fd3
in codegen, use StructRet where appropriate
vtjnash Sep 17, 2015
1c584ea
fix compiler warning
JeffBezanson Sep 17, 2015
df6db8b
fix doctests again
tkelman Sep 17, 2015
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
basedocs: abstract, bitstype, module, baremodule, macro
macro 4 spaces

(cherry picked from commit 04e94c2)
ref #13177
  • Loading branch information
catawbasam authored and tkelman committed Sep 17, 2015
commit 35969652e9df480650fe6064eddb273a7cda73b4
55 changes: 55 additions & 0 deletions base/docs/basedocs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,61 @@ keywords[:export] = doc"""
Test.bar(1) # 1
"""

keywords[:abstract] = doc"""
`abstract` declares a type that cannot be instantiated, and serves only as a node in the type graph,
thereby describing sets of related concrete types: those concrete types which are their descendants.
Abstract types form the conceptual hierarchy which makes Julia’s type system more than just a collection of object implementations.
For example:
abstract Number
abstract Real <: Number
`abstract Number` has no supertype, whereas `abstract Real` is an abstract subtype of `Number`.
"""

keywords[:module] = doc"""
`module` declares a Module, which is a separate global variable workspace. Within a module, you can control which names from other modules are visible (via importing), and specify which of your names are intended to be public (via exporting). For example:
module
import Base.show
export MyType, foo
type MyType
x
end
bar(x) = 2x
foo(a::MyType) = bar(a.x) + 1
show(io, a::MyType) = print(io, "MyType $(a.x)")
end
Modules allow you to create top-level definitions without worrying about name conflicts when your code is used together with somebody else’s.
"""

keywords[:baremodule] = doc"""
`baremodule` declares a module that does not contain `using Base`, `import Base.call`,
or a definition of `eval`. It does still import `Core`.
"""

keywords[:bitstype] = doc"""
`bitstype` declares a concrete type whose data consists of plain old bits. Classic examples of bits types are integers and floating-point values. Some example built-in bits type declarations:
bitstype 32 Char
bitstype 8 Bool <: Integer
The first parameter indicates how many bits of storage the type requires. Currently, only sizes that are multiples of 8 bits are supported. The second parameter gives the name of the type. The `Bool` declaration shows how a bits type can be optionally declared to be a subtype of some supertype.
"""

keywords[:macro] = doc"""
`macro` defines a method to include generated code in the final body of a program. A macro maps a tuple of arguments to a returned expression, and the resulting expression is compiled directly rather than requiring a runtime `eval()` call. Macro arguments may include expressions, literal values, and symbols. For example:
macro sayhello(name)
return :( println("Hello, ", $name) )
end
This macro takes one argument: `name`. When `@sayhello` is encountered, the quoted expression is expanded to interpolate the value of the argument into the final expression.
"""

keywords[:const] = doc"""
`const` is used to declare global variables which are also constant.
In almost all code (and particularly performance sensitive code)
Expand Down