Skip to content

Fix typo in docs that affected the formatting on the website#200

Merged
vincentarelbundock merged 1 commit intograntmcdermott:mainfrom
etiennebacher:typo-docs
Aug 13, 2024
Merged

Fix typo in docs that affected the formatting on the website#200
vincentarelbundock merged 1 commit intograntmcdermott:mainfrom
etiennebacher:typo-docs

Conversation

@etiennebacher
Copy link
Copy Markdown
Contributor

@etiennebacher etiennebacher commented Aug 13, 2024

This lonely backtick in the R file generated several \verb{} tags in the Rd file (cf etiennebacher/altdoc#289 (comment)), which then messed up the formatting of the arguments section:

https://grantmcdermott.com/tinyplot/man/tinyplot.html#arguments

image

Fixing this typo also fixes the formatting on the website.

Related to etiennebacher/altdoc#289

@vincentarelbundock
Copy link
Copy Markdown
Collaborator

Thanks for the PR, this is great!

@vincentarelbundock vincentarelbundock merged commit c2f6495 into grantmcdermott:main Aug 13, 2024
@etiennebacher etiennebacher deleted the typo-docs branch August 13, 2024 12:16
@grantmcdermott
Copy link
Copy Markdown
Owner

Shouldn't this have both backticks included (rather than dropped) to be consistent with the rest of the sentence? C.f. "ticks" etc.

Thanks for the catch, though!

@etiennebacher
Copy link
Copy Markdown
Contributor Author

Oh right, I removed it because the following "none" didn't have backticks but I didn't check the rest. I'll make another PR to add backticks on all values

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