Spelling #37
Open
Spelling #37
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jsoref
commented
Oct 12, 2025
| This is the opposite direction from what **edown** otherwise does. | ||
|
|
||
| markedoc translates [Markdown][] formatted texts into [Erlang][] [EDoc][] format, for inclusion into [EDoc][] generated html docs. It is for use on Linux, FreeBSD and Mac OS X and any system that you can install **[sed][Requirements]** on. | ||
| markedoc translates [Markdown][] formatted texts into [Erlang][] [EDoc][] format, for inclusion into [EDoc][] generated html docs. It is for use on Linux, FreeBSD and macOS and any system that you can install **[sed][Requirements]** on. |
Contributor
Author
There was a problem hiding this comment.
The last release of "Mac OS X" was Snow Leopard (10.6 in 2009). "macOS" is the current brand (since 10.12, 2016): https://en.wikipedia.org/wiki/MacOS_version_history
| @docfile "doc/README.edoc" | ||
|
|
||
| By running sed, then edoc, this makes the README.edoc part of the overview page. You could also make the README.md straight into an overview.edoc but the way it is allows allows to embed it into additional context information that should be useful for a proper html doc. | ||
| By running sed, then edoc, this makes the README.edoc part of the overview page. You could also make the README.md straight into an overview.edoc but the way it is allows to embed it into additional context information that should be useful for a proper html doc. |
Contributor
Author
There was a problem hiding this comment.
fwiw, i'd be inclined to write allows embedding it instead of allows to embed it, but that's a much more careful reading as opposed to a naive rule.
| * added classes for ``< li >'' list item tags for '[..]:...'-references | ||
| * fixed italic and bold merker interference bullet points | ||
| * eliminated [..]: part of '[..]:...'-references, flipping "..." to lead | ||
| * added classes for ``< li >`` list item tags for `[..]:...`-references |
Contributor
Author
There was a problem hiding this comment.
I think `` ... '' is (La)TeX, but this is Markdown, so it makes sense to use `` ... `` / ` ... ` instead.
| <li> <b>Yxa</b>: The first Erlang MySQL driver seems to have been written in 2005 by <a href="javascript:goto('ma')" onMouseOver="this.title=url('ma')">Magnus Ahltorp</a> at the <a href="javascript:goto('3')" onMouseOver="this.title=url('3')">Royal Institute of Technology</a>. It is the basis for the following two. The <a href="javascript:goto('4')" onMouseOver="this.title=url('4')">original mysql driver source</a> is stable since at least 2007, it is available as part of the SIP proxy <a href="javascript:goto('5')" onMouseOver="this.title=url('5')">Yxa 1.0</a> (hosted <a href="javascript:goto('6')" onMouseOver="this.title=url('6')">on github</a>).</li> | ||
|
|
||
| <li> <b>ejabberd</b>: Already in 2006, a <a href="javascript:goto('7')" onMouseOver="this.title=url('7')">fork</a> was created by <a href="javascript:goto('mr')" onMouseOver="this.title=url('mr')">Mickael Remond</a> at <a href="javascript:goto('8')" onMouseOver="this.title=url('8')">Process One</a> to become part of the successful instant messaging server <a href="javascript:goto('9')" onMouseOver="this.title=url('9')">ejabberd</a> (also hosted <a href="javascript:goto('10')" onMouseOver="this.title=url('10')">at github</a>). It can be assumed to be as stable as the Yxa branch, and it didn't change anything in the lowest level, mysql_recv.erl. The differences to the original Yxa branch mainly consists of added inspection functions that help using query results, and an <a href="javascript:goto('11')" onMouseOver="this.title=url('11')">independent adoption</a> to the MySQL 4.1 client-server protocol. Also, the original Yxa branch has meanwhile adopted edoc comment format. Find a diff <a href="javascript:goto('12')" onMouseOver="this.title=url('12')">here</a>, one ignoring comment lines <a href="javascript:goto('13')" onMouseOver="this.title=url('13')">here</a>.</li> | ||
| <li> <b>ejabberd</b>: Already in 2006, a <a href="javascript:goto('7')" onMouseOver="this.title=url('7')">fork</a> was created by <a href="javascript:goto('mr')" onMouseOver="this.title=url('mr')">Mickael Remond</a> at <a href="javascript:goto('8')" onMouseOver="this.title=url('8')">Process One</a> to become part of the successful instant messaging server <a href="javascript:goto('9')" onMouseOver="this.title=url('9')">ejabberd</a> (also hosted <a href="javascript:goto('10')" onMouseOver="this.title=url('10')">at github</a>). It can be assumed to be as stable as the Yxa branch, and it didn't change anything in the lowest level, mysql_recv.erl. The differences to the original Yxa branch mainly consists of added inspection functions that help using query results, and an <a href="javascript:goto('11')" onMouseOver="this.title=url('11')">independent adoption</a> to the MySQL 4.1 client-server protocol. Also, the original Yxa branch has meanwhile adopted edoc comment format. See a <a href="javascript:goto('12')" onMouseOver="this.title=url('12')">Diff of ejabberd mysql driver vs yxa mysql driver</a>, or a <a href="javascript:goto('13')" onMouseOver="this.title=url('13')">Diff of ejabberd mysql driver vs yxa mysql driver (comment changes ignored)</a>.</li> |
Contributor
Author
There was a problem hiding this comment.
It's possible this isn't a proper change.
as a general rule:
Do not use (click) here links
For more information, see:
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
…ges ignored) Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR corrects misspellings identified by the check-spelling action
The misspellings have been reported at https://github.com/jsoref/uwiger-edown/actions/runs/18447484478/attempts/1#summary-52556243143
The action reports that the changes in this PR would make it happy: https://github.com/jsoref/uwiger-edown/actions/runs/18447484581/attempts/1#summary-52556243311