Skip to content

Fix typos #1738

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

Merged
merged 1 commit into from
Aug 6, 2025
Merged

Fix typos #1738

merged 1 commit into from
Aug 6, 2025

Conversation

lbm364dl
Copy link
Contributor

@lbm364dl lbm364dl commented Aug 2, 2025

No apostrophe when used as pronoun. I think I checked the whole project.

@lbm364dl lbm364dl marked this pull request as draft August 2, 2025 07:41
@lbm364dl lbm364dl changed the title Fix typos in neovim.qmd Fix _its_ typos Aug 2, 2025
@lbm364dl lbm364dl marked this pull request as ready for review August 2, 2025 07:47
@musvaage
Copy link

musvaage commented Aug 2, 2025

Sure, its shows possession, while it's is a contraction.

In any event, it might be a cleaner commit history if a soft reset was performed.

$ git reset --soft HEAD~2
$ git commit -m "fix typos"
$ git push -f origin patch-1
$

@musvaage
Copy link

musvaage commented Aug 3, 2025

Can merging be postponed?

I have a few more changes not the least of which are the below.

I'll write up a shell script with GNU sed commands to implement the changes and Post it in a new comment.

One should be careful with considering typos in changelogs as sometimes they appear in the description of a PR.

Additionally
accessibility
acknowledgment
additional
affiliations
affiliation
after which
appendix

$ grep -nr Additonally quarto-web
quarto-web/docs/authoring/language.qmd:9:Additonally, Quarto, Pandoc, and LaTeX will sometimes generate textual output that requires localization. For example, "Figure" or "List of Figures" for cross references, callout captions like "Note" or "Warning", or the "Code" caption for folded code chunks.
$ grep -nr accessability quarto-web
quarto-web/docs/get-started/computations/positron.qmd:291:For example, update the code cell for the scatter plot by adding a caption with `fig-cap`, and improve accessability by adding [alternative text](https://medium.com/nightingale/writing-alt-text-for-data-visualization-2a218ef43f81) with `fig-alt`:
$ grep -nr acknowlegment quarto-web
quarto-web/docs/websites/website-navigation.qmd:150:      - acknowlegment.qmd
$ grep -nr additonal quarto-web
quarto-web/docs/projects/scripts.qmd:30:If you are using TypeScript, please be sure to consult the section below on [Deno Scripts](#deno-scripts) for additonal details on the Deno standard library and importing external scripts.
$ grep -nr affilations quarto-web
quarto-web/docs/download/changelog/1.1/_changelog.md:155:- Properly handle duplicated affilations in author metadata (#1286)
$ grep -nr affilitation quarto-web
quarto-web/docs/authoring/title-blocks.qmd:41:![](images/document-title-block-banner.png){.border fig-alt="Title block with title and description against a blue background up top, and below a section with author, affilitation, and date published."}
quarto-web/docs/authoring/title-blocks.qmd:55:![](images/document-title-block-banner-custom.png){.border fig-alt="Title block with title and description against an image background up top, and below a section with author, affilitation, and date published."}
$ grep -nr afterwhich quarto-web
quarto-web/docs/computations/julia.qmd:493:packages into their notebooks in a `{{julia}}` cell afterwhich they can use
$ grep -nr appendex quarto-web
quarto-web/docs/download/changelog/1.3/_changelog.md:201:- Properly support localized appendex name in book website navigation ([#4578](https://github.com/quarto-dev/quarto-cli/issues/4578))
$

@lbm364dl lbm364dl force-pushed the patch-1 branch 2 times, most recently from 8d2caea to 79b8be5 Compare August 4, 2025 07:21
@musvaage
Copy link

musvaage commented Aug 4, 2025

@cderv

By the way are contributor's expected to sign a CLA?

@lbm364dl

I suppose you have access to a GNU sed version for in place file modification; macOS uses BSD sed.

These are just some example lines, not yet the promised shell script with the entirety of the suggested fixes.

Expected
correspondence
especially

$ sed -i "s/Expectected/Expected/g" \
> quarto-web/docs/dashboards/_examples/gapminder-notebook.ipynb
$ sed -i "s/corrispondence/correspondence/g" \
> quarto-web/docs/dashboards/_examples/gapminder-notebook.ipynb
$ sed -i "s/expecially/especially/g" \
> quarto-web/docs/dashboards/_examples/gapminder-notebook.ipynb
$

@lbm364dl
Copy link
Contributor Author

lbm364dl commented Aug 4, 2025

How do you find the typos? I don't think it's just you searching random words, is it?

@musvaage
Copy link

musvaage commented Aug 4, 2025

For this Issue my comments pertain exclusively to the docs subdirectory.

I had cloned the repository and dumped strings from the docs subdirectory.

grep -o -E -r "\w+('\w+)*" quarto-web/docs | sort -u -f > output

cut -d : -f2 output | sort -u -f > strings

One can then filter out using whatever language one prefers certain strings resulting is a considerably smaller file.

I'm aware of codespell but factually never used it. Another programmer whom I've had email exchanges with over the years once described codespell as that it's useful, but noted it misses things. That being said the corpus of codespell continues to be added to, thus improving its efficiency.

@lbm364dl lbm364dl changed the title Fix _its_ typos Fix typos Aug 5, 2025
@lbm364dl
Copy link
Contributor Author

lbm364dl commented Aug 5, 2025

I added the other fixes you suggested. For the changelog ones I checked that the messages weren't part of the linked PR, so it should be fine.

@musvaage
Copy link

musvaage commented Aug 5, 2025

cf: #1738 (comment)

Mistakenly I reproduced the typos rather than specifying the fixes above the sed commands; this has been corrected.

My personal preference which does not necessarily express the consensus of the Developers/Maintainers is where textual changes are to be implemented within a markdown table thereby obliging table adjustment, then the adjustment might as well align that table.

docs/reference/formats/dashboard.qmd

In this .qmd file your PR has removed an apostrophe and then on the same line added whitespace to the table.

Do not use these patches which are for illustrative purposes only.

--- a/docs/reference/formats/dashboard.qmd	2025-08-02 15:21:27.507044150 -0500
+++ b/docs/reference/formats/dashboard.qmd	2025-08-05 11:53:39.499431570 -0500
@@ -117,14 +117,14 @@
 
 Card options enable you to specify a title and various layout behaviors:
 
-| Option       | Description                                                                                                                                                   |
-|--------------------------|----------------------------------------------|
-| `title`      | Title displayed in card header                                                                                                                                |
-| `padding`    | Padding around card content (default: `8px`)                                                                                                                  |
-| `expandable` | Make card content expandable (default: `true`)                                                                                                                |
-| `width`      | Percentage or absolute pixel width (default distributes space evenly across elements in a row)                                                                |
-| `height`     | Percentage or absolute pixel height (default distributes space evenly across elements in a column)                                                            |
-| `fill`       | Whether the card should fill it's container or 'flow', matching the height of its content. (Quarto determines the default value based upon the card contents) |
+| Option       | Description                                                                                                                                                  |
+|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `title`      | Title displayed in card header                                                                                                                               |
+| `padding`    | Padding around card content (default: `8px`)                                                                                                                 |
+| `expandable` | Make card content expandable (default: `true`)                                                                                                               |
+| `width`      | Percentage or absolute pixel width (default distributes space evenly across elements in a row)                                                               |
+| `height`     | Percentage or absolute pixel height (default distributes space evenly across elements in a column)                                                           |
+| `fill`       | Whether the card should fill its container or 'flow', matching the height of its content. (Quarto determines the default value based upon the card contents) |
 
 For example:
 

Separately there's another location where it's as a contraction is mistakenly present rather than its showing possession,.

--- a/docs/interactive/ojs/shiny.qmd	2025-08-02 15:21:27.252044132 -0500
+++ b/docs/interactive/ojs/shiny.qmd	2025-08-05 12:01:58.341465060 -0500
@@ -82,11 +82,11 @@
 
 Here are some examples that demonstrate various ways to use OJS with Shiny:
 
-| Example                                                        | Source                       | Description                                                                                                        |
-|----------------------------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------|
-| [K-Means](https://jjallaire.shinyapps.io/kmeans-shiny-ojs/)    | [Code](https://git.io/J0kPK) | Simple example of binding OJS inputs to Shiny inputs and shiny reactives to OJS plots.                             |
-| [Binning](https://jjallaire.shinyapps.io/binning-shiny-ojs/)   | [Code](https://git.io/J0kPu) | Demonstrates fast binning of a medium sized dataset (32mb) on the server.                                          |
-| [Data Binding](https://jjallaire.shinyapps.io/data-shiny-ojs/) | [Code](https://git.io/J0kPl) | Demonstrates importing a notebook from <https://observablehq.com> and binding it's data field to a Shiny reactive. |
+| Example                                                        | Source                       | Description                                                                                                       |
+|----------------------------------------------------------------|------------------------------|-------------------------------------------------------------------------------------------------------------------|
+| [K-Means](https://jjallaire.shinyapps.io/kmeans-shiny-ojs/)    | [Code](https://git.io/J0kPK) | Simple example of binding OJS inputs to Shiny inputs and shiny reactives to OJS plots.                            |
+| [Binning](https://jjallaire.shinyapps.io/binning-shiny-ojs/)   | [Code](https://git.io/J0kPu) | Demonstrates fast binning of a medium sized dataset (32mb) on the server.                                         |
+| [Data Binding](https://jjallaire.shinyapps.io/data-shiny-ojs/) | [Code](https://git.io/J0kPl) | Demonstrates importing a notebook from <https://observablehq.com> and binding its data field to a Shiny reactive. |
 
 ## Bindings
 

Personally I wouldn't pursue other tables' alignment than for those tables where specific typo corrections are to be made.

By the way are contributor's expected to sign a CLA?

I'll await a response from the Maintainers to the above question prior to suggesting more typo fixes.

@lbm364dl
Copy link
Contributor Author

lbm364dl commented Aug 6, 2025

My personal preference which does not necessarily express the consensus of the Developers/Maintainers is where textual changes are to be implemented within a markdown table thereby obliging table adjustment, then the adjustment might as well align that table.

I think the common approach is to not change lines that are not directly related to your PR (thus adding the space instead of removing one from all lines), but I can fix them if necessary, of course. I agree, let's let maintainers decide.

Separately there's another location where it's as a contraction is mistakenly present rather than its showing possession

Somehow I missed that one, thank you.

@musvaage
Copy link

musvaage commented Aug 6, 2025

This PR is becoming unwieldly; I am not going to comment further.

The typo fixes to date look correct; changelog fixes don't alter PR titles.

If merged any additional work on documentation improvements can be addressed in a new PR.

maintainers decide

to elaborate

Hmm, I think it's more presentable, and the actual code is easier to read, where tables affected by typo fixes are aligned.

A sequentially later editor of the files with tables will have thier time occupied figuring out why one extra white space is present.

@cscheid
Copy link
Collaborator

cscheid commented Aug 6, 2025

Thanks for the PR!

(No, we're not going to delay merging this, because these are already good improvements.)

(For sufficiently large contributions we do expect a signed CLA. We consider fixing typos valuable, but don't consider a CLA necessary in this case.)

@cscheid cscheid merged commit 6cdab90 into quarto-dev:main Aug 6, 2025
github-actions bot pushed a commit that referenced this pull request Aug 6, 2025
(cherry picked from commit 6cdab90)
Copy link
Contributor

github-actions bot commented Aug 6, 2025

Successfully created backport PR for prerelease:

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

Successfully merging this pull request may close these issues.

3 participants