Skip to content

JavaScript cleanup in API Docs. #5001

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
Merged
merged 5 commits into from
Mar 22, 2017
Merged

JavaScript cleanup in API Docs. #5001

merged 5 commits into from
Mar 22, 2017

Conversation

jpadilla
Copy link
Member

@jpadilla jpadilla commented Mar 18, 2017 •
edited
Loading

Description

Small cleanup and refactor following interactive documentation support. Nothing too crazy, but can discuss further.

  • Remove unused base.js script
  • Move bootstrap data attrs to anchor to fix # added to URL when switching auth method.
  • Cleanup and refactor api.js: Stick to standardjs.com like coreapi.js, cache jQuery selectors, prefix DOM related variables with $, etc.
  • Use var instead of const and let.
  • Drop for..of
  • Drop Array.from
  • Drop assignment destructuring

Related to #4961 #5000 #4994

@jpadilla jpadilla self-assigned this Mar 18, 2017
@tomchristie tomchristie changed the title Docs cleanup JavaScript cleanup in API Docs. Mar 20, 2017
@jpadilla
Copy link
Member Author

Just tested these changes on a couple different browsers in BrowserStack and everything seems fine. Anyone care for a review?

@tomchristie tomchristie merged commit 0fdaf4f into encode:master Mar 22, 2017
@tomchristie
Copy link
Member

Great stuff!

@tomchristie tomchristie added this to the 3.6.3 Release milestone Mar 22, 2017
@jpadilla
Copy link
Member Author

@tomchristie it'd be interesting to consider at some point some acceptance tests for interactive docs and browsable api features.

@jpadilla jpadilla deleted the docs-cleanup branch March 22, 2017 14:05
@tomchristie
Copy link
Member

Yup, interested to hear any thoughts there!

@dczech
Copy link

dczech commented Apr 26, 2017

@jpadilla any update on bugfix regarding the problem described in [0fdaf4f]? Do you want me to create an issue for that?

@jpadilla
Copy link
Member Author

@dczech Yes, please create an issue for it, any steps to reproduce, browser info, etc. Thanks!

@dczech dczech mentioned this pull request Apr 26, 2017
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@jpadilla jpadilla

Labels
Cleanup
Projects
None yet
Milestone
3.6.3 Release
Development

Successfully merging this pull request may close these issues.
3 participants
@jpadilla @tomchristie @dczech