Skip to content

[explicit-function-return-type] Unfortunate typo in documentation #769

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
Closed
ghost opened this issue Jul 28, 2019 · 2 comments · Fixed by #772
Closed

[explicit-function-return-type] Unfortunate typo in documentation #769

ghost opened this issue Jul 28, 2019 · 2 comments · Fixed by #772
Labels
documentation Documentation ("docs") that needs adding/updating has pr there is a PR raised to close this package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin

Comments

@ghost
Copy link

ghost commented Jul 28, 2019 •
edited by ghost
Loading

In the last example under allowTypedFunctionExpressions, functionWithObjectArg is written as

declare functionWithObjectArg(arg: { meth: () => number });
functionWithObjectArg({
  meth() {
    return 1;
  },
});

rather than what I imagine was the intended code:

declare functionWithObjectArg(arg: { method: () => number });
functionWithObjectArg({
  method() {
    return 1;
  },
});

My apologies if I have mislabeled this issue.
@ghost ghost added package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin triage Waiting for team members to take a look labels Jul 28, 2019
@bradzacher bradzacher added documentation Documentation ("docs") that needs adding/updating and removed triage Waiting for team members to take a look labels Jul 29, 2019
@bradzacher
Copy link
Member

bradzacher commented Jul 29, 2019 •
edited
Loading

a bit of lazy shorthand, yeah.
feel free to PR change it.

For future reference, making single-file changes is easy - you should be able to edit the file within the github UI, and it will automatically let you create a fork and raise a PR. It only takes a few clicks, and you won't have to leave your browser.

@ghost
Copy link
Author

ghost commented Jul 29, 2019 via email •
edited by ghost
Loading

@ghost ghost mentioned this issue Jul 29, 2019
Merged
@bradzacher bradzacher added the has pr there is a PR raised to close this label Jul 29, 2019
bradzacher pushed a commit that referenced this issue Jul 29, 2019
@bradzacher
docs: fix typo in documentation for explicit-function-return-type (#772)
24dac45 
Resolves #769.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 21, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Documentation ("docs") that needs adding/updating has pr there is a PR raised to close this package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: fix typo in documentation for explicit-function-return-type
1 participant
@bradzacher