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

“Introduction” revision #2

Closed
15 of 17 tasks
rodrigogiraoserrao opened this issue Jun 4, 2021 · 8 comments
Closed
15 of 17 tasks

“Introduction” revision #2

rodrigogiraoserrao opened this issue Jun 4, 2021 · 8 comments

Comments

@rodrigogiraoserrao
Copy link

rodrigogiraoserrao commented Jun 4, 2021

Revision

Here I include all of the things that, to the best of my knowledge and experience, should be changed/corrected.

  • Inconsistent casing of programming language names (APL, J, K, Q all show up in upper-case, but then we can find java, c, c++, rust, go, etc)
  • typos and similar issues:
    • "c, c++, Java, Python etc" → "c, c++, Java, Python, etc"
    • "code you write in other languages suddenly become" → "code you write in other languages suddenly becomes"
    • "Learning how to solve problems the data-parallel way, no loops, no branching is the" → "Learning how to solve problems the data-parallel way, no loops, no branching, is the"
    • "have to be a math-wiz to understand, or benefit from APL" → "have to be a math-wiz to understand, or benefit, from APL"
    • "no other general purpose programming language" → "no other general-purpose programming language"
    • "Tack might seen" → "Tack might seem"
    • "the function takes both a left, and a right argument, like" → "the function takes both a left, and a right, argument, like"
    • "only takes a right-side argument" → "only takes a right argument"
    • "argument, for example factorial, !:" → "argument; for example, factorial !:"
    • "if you hover over a glyph in the menu bar" → "if you hover over a glyph in the language bar"
    • "both its monadic, and dyadic uses, where applicable." → "both its monadic and dyadic uses, where applicable."

To consider

In here I include things that, from my point of view, would be nice additions/modifications.

  • Adding the link to the original xkcd comic, either as a hyperlink for the image itself, or when you mention the name of xkcd
  • Changing "d-fun" and "dfun" to "dfn" (possibly adding a note on pronunciation, if that was the original concern)
  • Add link to the online mdapl (https://mastering.dyalog.com) when you mention that work on it is afoot
  • Use double ~ in "an endless source of confusion joy" to add the actual strikethrough over "confusion"
@rodrigogiraoserrao
Copy link
Author

Consider going from to ⎕← for explicit output, e.g.

v  9?9
 becomes
 v  9?9

@xpqz
Copy link
Owner

xpqz commented Jun 8, 2021

On code you write in other languages suddenly become -- I think this is the correct form, treating code as plural.

https://www.wordhippo.com/what-is/the-plural-of/code.html

@xpqz
Copy link
Owner

xpqz commented Jun 8, 2021

Still can't get the overstrike to render properly in the jupyterbook html. Tried the double-tilde but no workie.

xpqz added a commit that referenced this issue Jun 8, 2021
@xpqz
Copy link
Owner

xpqz commented Jun 8, 2021

Mostly fixed in #2ef1e34

Leaving issue open for now.

@rodrigogiraoserrao
Copy link
Author

On code you write in other languages suddenly become -- I think this is the correct form, treating code as plural.

https://www.wordhippo.com/what-is/the-plural-of/code.html

I think "code" here is uncountable (like the link also says it can be) and, therefore, handled as if singular. I always think about the words "rice" or "money". You wouldn't say "rice become cooked after boiling for a bit", nor would you say "my money become wrinkled after I stuff it in my pockets."; in both you'd use "becomes".

@rodrigogiraoserrao
Copy link
Author

Still can't get the overstrike to render properly in the jupyterbook html. Tried the double-tilde but no workie.

The jupyter book markdown cheatsheet doesn't talk about strikethrough (https://jupyterbook.org/reference/cheatsheet.html) nor can I find anything about it in two other cheatsheets I reference recurringly (https://www.markdownguide.org/basic-syntax/ and https://daringfireball.net/projects/markdown/syntax#em). Maybe use the <s> HTML tag? Using it inline should work without any problem.

@xpqz
Copy link
Owner

xpqz commented Jun 11, 2021

Ah yes, inline html does the job.

@xpqz
Copy link
Owner

xpqz commented Jun 11, 2021

Fixed as part of the larger c04f45f

@xpqz xpqz closed this as completed Jun 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants