Skip to content

Commit

Permalink
Replace ⇔ by ↔ in documentation (#52078)
Browse files Browse the repository at this point in the history
There is no HTML entity `⇔` and accordingly all the usual browsers
(Chrome, Firefox, Safari) don't render it.

My guess is that there is confusion because GitHub supports `⇔` and
shows it as ⇔ (and `↔` as ↔).

But here is for example what Firefox shows:
<img width="853" alt="Screen Shot 2023-11-08 at 14 02 01"
src="https://github.com/JuliaLang/julia/assets/241512/af7d9e27-a5c3-46c3-94d9-82ed52653cb4">

This patch could be backported to 1.9 and 1.10.

(cherry picked from commit 81c4f8e)
  • Loading branch information
fingolfin authored and KristofferC committed Jan 24, 2024
1 parent f06a63d commit 6fdf37e
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions doc/src/manual/noteworthy-differences.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ For users coming to Julia from R, these are some noteworthy differences:
it's more general than that since methods are dispatched on every argument type, not only `this`,
using the most-specific-declaration rule).

### Julia &hArr; C/C++: Namespaces
### Julia &harr; C/C++: Namespaces
* C/C++ `namespace`s correspond roughly to Julia `module`s.
* There are no private globals or fields in Julia. Everything is publicly accessible
through fully qualified paths (or relative paths, if desired).
Expand All @@ -364,7 +364,7 @@ For users coming to Julia from R, these are some noteworthy differences:
* Caveat: `import`/`using` (Julia) works only at the global scope level (`module`s)
* In C++, `using namespace X` works within arbitrary scopes (ex: function scope).

### Julia &hArr; C/C++: Module loading
### Julia &harr; C/C++: Module loading
* When you think of a C/C++ "**library**", you are likely looking for a Julia "**package**".
* Caveat: C/C++ libraries often house multiple "software modules" whereas Julia
"packages" typically house one.
Expand Down Expand Up @@ -395,7 +395,7 @@ For users coming to Julia from R, these are some noteworthy differences:
* Directory-based package repositories are the **quickest solution** to developping local
libraries of "software modules".

### Julia &hArr; C/C++: Assembling modules
### Julia &harr; C/C++: Assembling modules
* In C/C++, `.c`/`.cpp` files are compiled & added to a library with build/`make` scripts.
* In Julia, `import [PkgName]`/`using [PkgName]` statements load `[PkgName].jl` located
in a package's `[PkgName]/src/` subdirectory.
Expand All @@ -412,9 +412,9 @@ For users coming to Julia from R, these are some noteworthy differences:
Julia package* ("software module"). It is therefore relatively straightforward to ensure
file are `include`d only once (No `#ifdef` confusion).

### Julia &hArr; C/C++: Module interface
* C++ exposes interfaces using "public" `.h`/`.hpp` files whereas Julia `module`s `export`
symbols that are intended for their users.
### Julia &harr; C/C++: Module interface
* C++ exposes interfaces using "public" `.h`/`.hpp` files whereas Julia `module`s mark
specific symbols that are intended for their users as `public`or `export`ed.
* Often, Julia `module`s simply add functionality by generating new "methods" to existing
functions (ex: `Base.push!`).
* Developers of Julia packages therefore cannot rely on header files for interface
Expand All @@ -425,7 +425,7 @@ For users coming to Julia from R, these are some noteworthy differences:
* Users might be expected to access these components by qualifying functions/structs/...
with the package/module name (ex: `MyModule.run_this_task(...)`).

### Julia &hArr; C/C++: Quick reference
### Julia &harr; C/C++: Quick reference

| Software Concept | Julia | C/C++ |
| :--- | :--- | :--- |
Expand Down

0 comments on commit 6fdf37e

Please sign in to comment.