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

[Docs Bug 🐞 report]: Typo in error log #1036

Closed
1 task done
michael-ball-ctct opened this issue Sep 13, 2023 · 3 comments
Closed
1 task done

[Docs Bug 🐞 report]: Typo in error log #1036

michael-ball-ctct opened this issue Sep 13, 2023 · 3 comments

Comments

@michael-ball-ctct
Copy link
Contributor

Describe the bug you found in AsyncAPI Docs.

I apologise if this isn't strictly a "Docs" bug, but there's what appears to be a small typo in one of the error messages. I figure that's closer to being a "Docs" issue than it is a functionality one.

At generator.js, line 264 the error message currently reads 'Input is not a corrent AsyncAPI document so it cannot be processed.' "Corrent" isn't a word in English, so this message could be a little bit clearer. Is it meant to be "correct", or "current", or something else? My suspicion (given the context) is that it is meant to be "correct", although I would recommend updating it to be "valid" as that seems like a slightly more appropriate word.

I'm happy to make the PR if there's concensus on what the right wording is - just let me know whether this is a "docs:" or a "chore:" commit.

Attach any resources that can help us understand the issue.

    if (!document) {
      const err = new Error('Input is not a corrent AsyncAPI document so it cannot be processed.');
      err.diagnostics = diagnostics;
      throw err;
    }

Code of Conduct

  • I agree to follow this project's Code of Conduct
@github-actions
Copy link
Contributor

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@derberg
Copy link
Member

derberg commented Oct 4, 2023

@michael-ball-ctct sorry for being late, yes, please open a PR.

chore will not trigger a release, so you need to do fix so we release a patch, and make new fixed error available in new release

@michael-ball-ctct
Copy link
Contributor Author

@derberg Looks like Jonas bundled this change up with a bunch of other stuff 2 days after I raised it (in 60f8e62 ). I'm happy with that resolution, so closing the issue. Cheers!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants