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

Fix and improve guide start in readme #762

Merged
merged 5 commits into from
Feb 1, 2019
Merged

Fix and improve guide start in readme #762

merged 5 commits into from
Feb 1, 2019

Conversation

NicolasMahe
Copy link
Member

No description provided.

@NicolasMahe NicolasMahe changed the title Fix improve guide start in readme Fix and improve guide start in readme Jan 31, 2019
ilgooz
ilgooz previously approved these changes Jan 31, 2019
Copy link
Member

@antho1404 antho1404 left a comment

Choose a reason for hiding this comment

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

I'm ok to have some verbosity but this is a quick start and should be quick, not perfect, I would remove the handling of errors here, on the document we need it, on the quick start not really we don't want to show a huge code that they might be afraid of.

I feel this code is 3 times bigger, that's not attracting

@NicolasMahe
Copy link
Member Author

I'm ok to have some verbosity but this is a quick start and should be quick, not perfect, I would remove the handling of errors here, on the document we need it, on the quick start not really we don't want to show a huge code that they might be afraid of.

I feel this code is 3 times bigger, that's not attracting

It's bigger not because of error handling but because of code style.

The only error added is on the return of the executeTaskAndWaitResult func:

      if (result.outputKey !== 'success') {
        const message = JSON.parse(result.outputData).message
        console.error('an error occurred while sending the invitation: ', message)
        return
      }

I think most developer don't check much the actual documentation, so having verbosity here will help them to understand what's going on.

README.md Outdated Show resolved Hide resolved
@antho1404 antho1404 merged commit 58e9c53 into master Feb 1, 2019
@NicolasMahe NicolasMahe deleted the fix/readme branch February 1, 2019 05:55
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