-
Notifications
You must be signed in to change notification settings - Fork 944
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
Fix typos #1738
Conversation
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.
|
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 One should be careful with considering typos in changelogs as sometimes they appear in the description of a PR. Additionally
|
8d2caea
to
79b8be5
Compare
By the way are contributor's expected to sign a CLA? @lbm364dl I suppose you have access to a GNU These are just some example lines, not yet the promised shell script with the entirety of the suggested fixes. Expected
|
How do you find the typos? I don't think it's just you searching random words, is it? |
For this Issue my comments pertain exclusively to the docs subdirectory. I had cloned the repository and dumped strings from the docs subdirectory.
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. |
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. |
cf: #1738 (comment) Mistakenly I reproduced the typos rather than specifying the fixes above the 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.
I'll await a response from the Maintainers to the above question prior to suggesting more typo fixes. |
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.
Somehow I missed that one, thank you. |
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.
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. |
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.) |
(cherry picked from commit 6cdab90)
Successfully created backport PR for |
No apostrophe when used as pronoun. I think I checked the whole project.