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.

Sign up for GitHub

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

Jump to bottom

Fix typos in documentation #6018

Closed
wants to merge 1 commit into from
Closed

Fix typos in documentation #6018

wants to merge 1 commit into from

Conversation

myersg86
Copy link 

packages/app-cli/tests/support/pluginRepo/README.md:18: coppy -> copy
packages/server/README.md:96: filesytem -> filesystem
packages/server/src/views/index/help.md:33: Offical -> Official
readme/api/references/rest_api.md:84: paramater -> parameter
readme/api/references/rest_api.md:129: refered -> referred, correspondance -> correspondence
readme/spec/e2ee.md:81: passowrd -> password

tessus
tessus requested changes Jan 15, 2022
View reviewed changes
Copy link
Collaborator

@tessus tessus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR.

Please do not commit the README.md in the root dir. e.g. you changed text that is generated....

Other than that there's a minor issue which I explained inline.

packages/app-cli/tests/support/pluginRepo/README.md
@@ -15,7 +15,7 @@ This repository contains the following plugins:
--- | --- | --- | --- | ---
[🏠](https://discourse.joplinapp.org/t/insert-referencing-notes-backlinks-plugin/13632) | Backlinks to note | 1.0.4 | Creates backlinks to opened note | a
[🏠](https://github.com/JackGruber/joplin-plugin-combine-notes) | Combine notes | 0.2.1 | Combine one or more notes | JackGruber
[🏠](https://github.com/JackGruber/joplin-plugin-copytags) | Copy Tags | 0.3.2 | Plugin to extend the Joplin tagging menu with a coppy all tags and tagging list with more control. | JackGruber
[🏠](https://github.com/JackGruber/joplin-plugin-copytags) | Copy Tags | 0.3.2 | Plugin to extend the Joplin tagging menu with a copy all tags and tagging list with more control. | JackGruber
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you check the corresponding test?

e.g. you can't just change text in a test, because the test could now fail or pass (when it passed or failed before)

@tessus tessus added the documentation Documentation, web site, README label Jan 15, 2022
Daeraxa
Daeraxa reviewed Jan 15, 2022
View reviewed changes
readme/api/references/rest_api.md
@@ -126,7 +126,7 @@ To retrieve all the tags that start with `project-`: **GET /search?query=project

# Item type IDs

Item type IDs might be refered to in certain object you will retrieve from the API. This is the correspondance between name and ID:
Item type IDs might be refereed to in certain object you will retrieve from the API. This is the correspondence between name and ID:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be referred and not refereed?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep

@tessus
Copy link
Collaborator

tessus commented Jan 20, 2022

@myersg86 are you going to look into the comments or shall I close the PR?

@myersg86 myersg86 closed this Jan 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tessus tessus tessus requested changes

@Daeraxa Daeraxa Daeraxa left review comments

Assignees
No one assigned
Labels
documentation Documentation, web site, README
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@myersg86 @tessus @Daeraxa