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.

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

Run ESLint on documentation + minor documentation improvements #1069

Merged
merged 6 commits into from
May 28, 2020
Merged

Run ESLint on documentation + minor documentation improvements #1069

merged 6 commits into from
May 28, 2020

Conversation

sc1f
Copy link
Contributor

@sc1f sc1f commented May 27, 2020 •
edited
Loading

This PR adds eslint-plugin-markdown and applies auto-formatting fixes to Javascript code blocks in our markdown documentation.

Additionally it fixes some formatting issues with the Python documentation, adds PerspectiveTornadoHandler to the Python documentation, as well as fixes typos, makes improvements & adds examples to both JS and Python docs.

@finos-admin
Copy link
Member

Thank you for your contribution and Welcome to our Open Source Community!

To make sure your pull request is accepted successfully, we ask all our open source contributors to sign a Contributor License Agreement.

Having reviewed our contributor list, we require a CLA for the following people : (@ibhanu).

If you need help obtaining a CLA, please read the Requirements for Contributions section of our CLA wiki or email help@finos.org with your questions.

Thanks once again for your contribution. Let us work with you to make the CLA process quick, easy and efficient so we can move forward with reviewing and accepting your pull request.

cc @finos-admin

@finos finos deleted a comment from finos-admin May 28, 2020
@texodus texodus merged commit ca9551d into master May 28, 2020
@texodus
Copy link
Member

texodus commented May 28, 2020

Thanks for the PR!

@texodus texodus deleted the doc-improvements branch May 28, 2020 14:11
@texodus
Copy link
Member

texodus commented May 28, 2020

Agh, I meant to leave a review before I merged that - so I'll do so posthumously.

Thanks alot @ibhanu, and thanks @sc1f for automating this process! The automation is really important I think, given the power of tools like eslint today, it seems silly not to automate anything we feel strongly enough about to auto-format in the first place!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@sc1f @finos-admin @texodus @meetali8 @ibhanu