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

Improve examples and their READMEs #517

Merged
merged 1 commit into from
Jul 20, 2020
Merged

Improve examples and their READMEs #517

merged 1 commit into from
Jul 20, 2020

Conversation

bidoubiwa
Copy link
Contributor

No description provided.

@bidoubiwa bidoubiwa requested a review from curquiza July 20, 2020 14:36
@bidoubiwa bidoubiwa changed the title Improve example and readme's Improve example and their readme's Jul 20, 2020
@bidoubiwa bidoubiwa added skip-changelog The PR will not appear in the release changelogs documentation Improvements or additions to documentation SDK JS and removed skip-changelog The PR will not appear in the release changelogs labels Jul 20, 2020
examples/browser/README.md Outdated Show resolved Hide resolved
examples/browser/README.md Outdated Show resolved Hide resolved
examples/node/README.md Outdated Show resolved Hide resolved
examples/node/README.md Outdated Show resolved Hide resolved

## Try out

To try it out you just need to execute the files:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
To try it out you just need to execute the files:
To try it out you just need to execute the file:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's files because their are more than one file in this directory,

Copy link
Member

Choose a reason for hiding this comment

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

But as the command below is node search_example.js, this is one file, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is one of the files that are present. Maybe I should add For example:

Copy link
Member

Choose a reason for hiding this comment

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

As you wish

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

examples/typescript-node/README.md Outdated Show resolved Hide resolved
examples/typescript-node/README.md Outdated Show resolved Hide resolved
examples/typescript-node/README.md Outdated Show resolved Hide resolved
examples/typescript-node/README.md Outdated Show resolved Hide resolved
examples/typescript-node/README.md Show resolved Hide resolved
@curquiza curquiza changed the title Improve example and their readme's Improve example and their READMEs Jul 20, 2020
@curquiza curquiza changed the title Improve example and their READMEs Improve examples and their READMEs Jul 20, 2020
examples/typescript-browser/README.md Outdated Show resolved Hide resolved
examples/typescript-browser/README.md Outdated Show resolved Hide resolved
examples/typescript-node/README.md Outdated Show resolved Hide resolved
examples/typescript-node/README.md Outdated Show resolved Hide resolved
End of file line

Editorconfig enabled

Linting and fixes

Spacing

Update examples/typescript-browser/README.md

Co-authored-by: Clémentine Urquizar <[email protected]>

Update examples/typescript-browser/README.md

Co-authored-by: Clémentine Urquizar <[email protected]>

Update examples/typescript-node/README.md

Co-authored-by: Clémentine Urquizar <[email protected]>

Update examples/typescript-node/README.md

Improve wording
@curquiza curquiza merged commit 1808f91 into master Jul 20, 2020
@curquiza curquiza deleted the improve_examples branch July 20, 2020 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants