Skip to content

Commit 768401c

Browse files
committed
Merge pull request #10447 from JuliaLang/nalimilan/stringdocs
Fix various details about strings in docs [av skip]
2 parents 42af2c4 + 83194f4 commit 768401c

File tree

5 files changed

+16
-17
lines changed

5 files changed

+16
-17
lines changed

doc/manual/metaprogramming.rst

+4-5
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,7 @@ but leaves expressions alone::
392392
julia> eval(ex)
393393
42
394394

395+
.. _man-macros:
395396

396397
Macros
397398
------
@@ -728,8 +729,6 @@ following macro sets ``x`` to zero in the call environment::
728729
This kind of manipulation of variables should be used judiciously, but
729730
is occasionally quite handy.
730731

731-
.. _man-non-standard-string-literals2:
732-
733732
Code Generation
734733
---------------
735734

@@ -780,10 +779,10 @@ cause a compile-time error:
780779
julia> $a + b
781780
ERROR: unsupported or misplaced expression $
782781

783-
.. _man-macros:
782+
.. _man-non-standard-string-literals2:
784783

785-
Non-Standard AbstractString Literals
786-
------------------------------------
784+
Non-Standard String Literals
785+
----------------------------
787786

788787
Recall from :ref:`Strings <man-non-standard-string-literals>` that
789788
string literals prefixed by an identifier are called non-standard string

doc/manual/strings.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -183,10 +183,10 @@ You can do comparisons and a limited amount of arithmetic with
183183
julia> 'A' + 1
184184
'B'
185185

186-
:obj:`AbstractString` Basics
187-
----------------------------
186+
String Basics
187+
-------------
188188

189-
:obj:`AbstractString` literals are delimited by double quotes or triple double quotes:
189+
String literals are delimited by double quotes or triple double quotes:
190190

191191
.. doctest::
192192

@@ -544,8 +544,8 @@ Some other useful functions include:
544544

545545
.. _man-non-standard-string-literals:
546546

547-
Non-Standard AbstractString Literals
548-
------------------------------------
547+
Non-Standard String Literals
548+
----------------------------
549549

550550
There are situations when you want to construct a string or use string
551551
semantics, but the behavior of the standard string construct is not

doc/stdlib/c.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
.. function:: ccall((symbol, library) or fptr, RetType, (ArgType1, ...), ArgVar1, ...)
88

9-
Call function in C-exported shared library, specified by ``(function name, library)`` tuple, where each component is a AbstractString or :Symbol. Alternatively,
9+
Call function in C-exported shared library, specified by ``(function name, library)`` tuple, where each component is an ``AbstractString`` or ``Symbol``. Alternatively,
1010
ccall may be used to call a function pointer returned by dlsym, but note that this usage is generally discouraged to facilitate future static compilation.
1111
Note that the argument type tuple must be a literal tuple, and not a tuple-valued variable or expression.
1212

doc/stdlib/io-network.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -539,23 +539,23 @@ Julia environments (such as the IPython-based IJulia notebook).
539539

540540
.. function:: reprmime(mime, x)
541541

542-
Returns a ``AbstractString`` or ``Vector{UInt8}`` containing the
542+
Returns an ``AbstractString`` or ``Vector{UInt8}`` containing the
543543
representation of ``x`` in the requested ``mime`` type, as written
544544
by ``writemime`` (throwing a ``MethodError`` if no appropriate
545-
``writemime`` is available). A ``AbstractString`` is returned for MIME
545+
``writemime`` is available). An ``AbstractString`` is returned for MIME
546546
types with textual representations (such as ``"text/html"`` or
547547
``"application/postscript"``), whereas binary data is returned as
548548
``Vector{UInt8}``. (The function ``istext(mime)`` returns whether
549549
or not Julia treats a given ``mime`` type as text.)
550550

551-
As a special case, if ``x`` is a ``AbstractString`` (for textual MIME types)
551+
As a special case, if ``x`` is an ``AbstractString`` (for textual MIME types)
552552
or a ``Vector{UInt8}`` (for binary MIME types), the ``reprmime`` function
553553
assumes that ``x`` is already in the requested ``mime`` format and
554554
simply returns ``x``.
555555

556556
.. function:: stringmime(mime, x)
557557

558-
Returns a ``AbstractString`` containing the representation of ``x`` in the
558+
Returns an ``AbstractString`` containing the representation of ``x`` in the
559559
requested ``mime`` type. This is similar to ``reprmime`` except
560560
that binary data is base64-encoded as an ASCII string.
561561

doc/stdlib/numbers.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -335,13 +335,13 @@ General Number Functions and Constants
335335

336336
.. function:: BigInt(x)
337337

338-
Create an arbitrary precision integer. ``x`` may be an ``Int`` (or anything that can be converted to an ``Int``) or a ``AbstractString``.
338+
Create an arbitrary precision integer. ``x`` may be an ``Int`` (or anything that can be converted to an ``Int``) or an ``AbstractString``.
339339
The usual mathematical operators are defined for this type, and results are promoted to a ``BigInt``.
340340

341341
.. function:: BigFloat(x)
342342

343343
Create an arbitrary precision floating point number. ``x`` may be
344-
an ``Integer``, a ``Float64``, a ``AbstractString`` or a ``BigInt``. The
344+
an ``Integer``, a ``Float64``, an ``AbstractString`` or a ``BigInt``. The
345345
usual mathematical operators are defined for this type, and results
346346
are promoted to a ``BigFloat``. Note that because floating-point
347347
numbers are not exactly-representable in decimal notation,

0 commit comments

Comments
 (0)