Documentation typos.

[Luís Oliveira]

Thanks, can you submit a pull request?

Luís

(sent from my phone)

On Tue, Sep 15, 2015, 14:24 Dmitry Igrishin <dfigrish at gmail.com> wrote:

> Hello,
>
> I've read the documentation and found these typos:
>
>
> https://common-lisp.net/project/slime/doc/html/Inferior_002dlisp.html#Inferior_002dlisp
>   "(see Loading Contribs for information on how to enable the REPL.)"
>   should be
>   "(See Loading Contribs for information on how to enable the REPL.)"
>
> https://common-lisp.net/project/slime/doc/html/Editing-Commands.html
> https://common-lisp.net/project/slime/doc/html/Macro_002dexpansion.html
> https://common-lisp.net/project/slime/doc/html/Scratch-Buffer.html
>   "sexp" better be "S-expression"
>
> https://common-lisp.net/project/slime/doc/html/Compilation.html#Compilation
>   "(See (emacs)Compilation Mode)"
>   should be
>   "(see (Emacs)Compilation Mode.)"
>
>
> https://common-lisp.net/project/slime/doc/html/Multithreading.html#Multithreading
>   "add a binding the swank:*default-worker-thread-bindings*"
>   should be
>   "add a binding to the swank:*default-worker-thread-bindings*"
>
> https://common-lisp.net/project/slime/doc/html/Evaluation.html#Evaluation
>
> https://common-lisp.net/project/slime/doc/html/Command-Index.html#Command-Index
>   "slime-eval-last-expression-display-output" -- no such command in SLIME
>
>
> https://common-lisp.net/project/slime/doc/html/slime_002dmrepl.html#slime_002dmrepl
>   "slime-open-listener" -- no such command in SLIME
>
>
> https://common-lisp.net/project/slime/doc/html/Fuzzy-Completion.html#Fuzzy-Completion
>   "slime-complete-symbol-function" -- obsolete, so
>   ‘slime-completion-at-point-functions’ should be referenced instead.
>
>
> https://common-lisp.net/project/slime/doc/html/Xref-and-Class-Browser.html#Xref-and-Class-Browser
>   "This command asks for a class name and displays inheritance tree of for
> the class."
>   should be
>   "This command asks for a class name and displays inheritance tree of the
> class."
>
>
> https://common-lisp.net/project/slime/doc/html/SLIME-Enhanced-M_002d_002e.html#SLIME-Enhanced-M_002d_002e
>   "slime-mdot-fu" -- no such contrib. "slime-mdot" is here.
>
>
> https://common-lisp.net/project/slime/doc/html/SLIME-Trace-Dialog.html#SLIME-Trace-Dialog
>   "the the *trace-output* stream"
>   should be
>   "the *trace-output* stream"
>
>
> https://common-lisp.net/project/slime/doc/html/Tips-and-Tricks.html#Tips-and-Tricks
>   "lisp" should be "Lisp"
>
>
> https://common-lisp.net/project/slime/doc/html/Connecting-to-a-remote-lisp.html#Connecting-to-a-remote-lisp
>   "swank" should be "Swank"
>   "lisp" should be "Lisp"
>
>
> https://common-lisp.net/project/slime/doc/html/Setting-up-the-lisp-image.html#Setting-up-the-lisp-image
>   "swank" should be "Swank"
>   "lisp" should be "Lisp"
>   "ssh" should be "SSH"
>   "emacs" should be "Emacs"
>
>   "See See Communication style."
>   should be
>   "See Communication style."
>
>   "On the emacs side you will use something like"
>   should be
>   "On the Emacs side you will use something like"
>
>   "(slime-connect "127.0.0.1" 4005))" extra right parenthesis
>
>
> https://common-lisp.net/project/slime/doc/html/Setting-up-Emacs.html#Setting-up-Emacs
>   "ssh" should be "SSH"
>   "swank" should be "Swank"
>
>
> https://common-lisp.net/project/slime/doc/html/Setting-up-pathname-translations.html#Setting-up-pathname-translations
>   "swank" should be "Swank"
>   "ssh" should be "SSH"
>
>   "if we want things like"
>   should be
>   "If we want things like"
>
>   "(See See (tramp)TRAMP User Manual.)"
>   should be
>   "(See (tramp)TRAMP User Manual.)"
>
> https://common-lisp.net/project/slime/doc/html/Banner.html#Banner
>    "( See (elisp)Header Lines.)"
>    should be
>    "(see (elisp)Header Lines)"
>
>
> https://common-lisp.net/project/slime/doc/html/Editing-Commands.html#Editing-Commands
>   "s-expression"
>   should be
>   "S-expression"
>
>   "s-expressions"
>   should be
>   "S-expressions"
>
>   "sexp"
>   should be
>   "S-expression"
>
>
> https://common-lisp.net/project/slime/doc/html/Typeout-frames.html#Typeout-frames
>   "(see Loading Contribs.)"
>   should be
>   "(See Loading Contribs.)"
>
> https://common-lisp.net/project/slime/doc/html/TRAMP.html#TRAMP
>   "(see Setting up pathname translations)"
>   should be
>   "(See Setting up pathname translations.)"
>
>
> https://common-lisp.net/project/slime/doc/html/slime_002dsprof.html#slime_002dsprof
>   "swank" should be "Swank"
>
>   "(callers, calls to)" should be "(callers, callees)"
>
> I think these changes will make the documentation to looks better.
> Also, it would be nice to replace everywhere:
>
> lisp -> Lisp
> emacs -> Emacs
> slime -> SLIME
> repl -> REPL
> ssh -> SSH
> swank -> Swank
> sexp -> S-expression
>
> --

Luís

(sent from my phone)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mailman.common-lisp.net/pipermail/slime-devel/attachments/20150915/d1a19c5d/attachment.html>