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: Remove superfluous object option sample code #10652

Merged
merged 1 commit into from
Jul 28, 2018

Conversation

revolter
Copy link
Contributor

What is the purpose of this pull request? (put an "X" next to item)

  • Documentation update
  • Bug fix (template)
  • New rule (template)
  • Changes an existing rule (template)
  • Add autofixing to a rule
  • Add a CLI option
  • Add something to the core
  • Other, please explain:

What changes did you make? (Give an overview)

The other rules don't have this sample code block, so this PR makes the no-else-return documentation consistent with the others.

Is there anything you'd like reviewers to focus on?

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Jul 22, 2018
@not-an-aardvark
Copy link
Member

Thanks for the PR! I'm fine with changing this for now for consistency, although my impression is that the example might be useful to users who don't know how to configure options. I wonder if it would be better to change other rules to add an example instead (although admittedly that might be a much bigger task).

@revolter
Copy link
Contributor Author

revolter commented Jul 22, 2018

Well, I'd like something else from these. I'd like for them (.md files) to be auto-generated instead of manually created. This way, the whole structure, formatting, and maintaining would be far easier. Similar to how fastlane does it.

A bit off-topic.

@revolter
Copy link
Contributor Author

revolter commented Jul 22, 2018

We also have a bunch of checks to prevent inconsistent or incorrect content.

@aladdin-add
Copy link
Member

I have a concern to change other rules: some rules have a very big number options (such as indent), and some and/or options could cause confusing.

@revolter
Copy link
Contributor Author

Maybe have a hyperlink on every rule that points to a separate doc explaining it?

@not-an-aardvark
Copy link
Member

I think it would be reasonable to autogenerate some parts of the documentation. Presumably, we would still need to manually write other parts (e.g. code samples and descriptions).

@platinumazure platinumazure added rule Relates to ESLint's core rules documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Jul 25, 2018
@aladdin-add aladdin-add reopened this Jul 26, 2018
@aladdin-add aladdin-add merged commit c2bb8bb into eslint:master Jul 28, 2018
@aladdin-add
Copy link
Member

thanks for contributing!

@revolter revolter deleted the patch-4 branch July 28, 2018 12:38
@revolter
Copy link
Contributor Author

Thanks for merging! Btw, the same examples are actually in the same file too, but closer to the end: https://github.com/revolter/eslint/blob/fa9c9e93cecfecd2871646c0dce2d2198854adda/docs/rules/no-else-return.md#allowelseif-false

@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Jan 25, 2019
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Jan 25, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation rule Relates to ESLint's core rules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants