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

Resolves eslint-plugin-jsdoc test failures #10858

Merged
merged 18 commits into from
Jul 16, 2021
Merged

Resolves eslint-plugin-jsdoc test failures #10858

merged 18 commits into from
Jul 16, 2021

Conversation

domlet
Copy link
Contributor

@domlet domlet commented Jul 14, 2021

  • Adds new eslint-plugin-jsdoc tests:
check-line-alignment
require-returns-type
require-description
check-access
require-property
  • Edits API docs to pass ^ these new tests.
  • Makes a small number rive-by copyedits in API docs.

Launch Checklist

  • briefly describe the changes in this PR
  • apply changelog label ('bug', 'feature', 'docs', etc) or use the label 'skip changelog'

Dom Brassey and others added 7 commits July 13, 2021 14:22
Adds 'resource type' prefix for related items in GL JS API docs (#10837)
2e6abd7 
* add prefix for related items in gl js api reference pages

* modify formatting to match style-spec

* Update src/ui/map.js

Co-authored-by: Asheem Mamoowala <asheem.mamoowala@mapbox.com>

* Update src/ui/camera.js

Co-authored-by: Asheem Mamoowala <asheem.mamoowala@mapbox.com>

* Update src/index.js

Co-authored-by: Asheem Mamoowala <asheem.mamoowala@mapbox.com>

* Update src/index.js

Co-authored-by: Asheem Mamoowala <asheem.mamoowala@mapbox.com>

* consistify formatting

* revert 3 changes

Co-authored-by: Asheem Mamoowala <asheem.mamoowala@mapbox.com>
@HeyStenson
fixes #7699 (#10841)
4674a01
@karimnaaji
Update style spec compatibility for #9847 and #4218 (#10846)
3dace34 
* Update style spec compatiblity for #9847 and #4218

Co-authored-by: Karim Naaji <karim.naaji@gmail.com>
Add geolocate test page (#10856)
a55d495
fixes tests for require-returns-type, require-description, check-acce…
8f29b2d 
…ss, require-property
change some Number to number, fix check-line-alignment and require-re…
6418fa8 
…turns-type
uncomment all other tests
03d9398
@domlet domlet added docs 📜 skip changelog Used for PRs that do not need a changelog entry labels Jul 14, 2021
HeyStenson
HeyStenson approved these changes Jul 14, 2021
View reviewed changes
Copy link
Contributor

@HeyStenson HeyStenson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes look good to me @domlet! If we can get a 👍 from someone on the product team to double-check the @returns and other big changes that'd be nice ❤️

SnailBones
SnailBones reviewed Jul 15, 2021
View reviewed changes
src/ui/camera.js Outdated Show resolved Hide resolved
Asheem Mamoowala and others added 5 commits July 15, 2021 09:44
Add Mobile SDK v10 support for terrain and sky (#10861)
ad08675
Add documentation for sourceId to MapDataEvent (#10830)
dd0aad4 
* add documentation for sourceId to MapDataEvent

* add details to the description for MapDataEvent sourceId
Merge branch 'testing-tests' into sprint/player0
0c9b929
@SnailBones
Update src/ui/camera.js
534d33a 
Co-authored-by: Aidan H <aidan.hendrickson@mapbox.com>
move eslint-plugin-jsdoc tests down
fe2f6e0
SnailBones
SnailBones approved these changes Jul 16, 2021
View reviewed changes
Copy link
Contributor

@SnailBones SnailBones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks great to me

@domlet domlet merged commit f3253fb into testing-tests Jul 16, 2021
@domlet domlet deleted the sprint/player0 branch July 16, 2021 20:31
HeyStenson added a commit that referenced this pull request Jul 28, 2021
@HeyStenson @ansis
@karimnaaji @rreusser @SnailBones @mourner @danswick
Add and update ESLint tests for Mapbox GL JS API docs (#10707)
36533f3 
* mapeventdata --> mapdataevent

* added require-property

* change warns to fails

* update tests

* ALL THE TESTS

* restore events.js

* updates and upgrades

* increase rigor of tests

* fix eslint errors for jsdoc examples (#10847)

* Add a few more examples (#10850)

* Add a few examples

* Update src/geo/mercator_coordinate.js

Co-authored-by: Ansis Brammanis <ansis@mapbox.com>

Co-authored-by: Ansis Brammanis <ansis@mapbox.com>

* Add some docs example (#10859)

* `require-example` linting (#10855)

* Add geojson source examples

* Add src/source/* inline examples

* Linter

* Lint

* Add camera examples

* Fixup

* Add camera examples

* Review comments

* Minor nit

* Apply jsdoc eslint rules only to public API files (#10854)

* `require-example` linting  (#10862)

* Last public facing examples

* Exclude private files from geo/ and promote require-example from warning to error

* `jsdoc/newline-after-description` linting (#10863)

* Update doc comments to conform to eslint-complete-sentences rule (#10851)

* Update doc comments to conform to eslint-complete-sentences rule

* Fix typo

* more detailed docs for return `this`

Extracted from Arindam's #10848

* Fix docs language

* Make complete-sentences an error

* Update eslintrc

* Cleanup

* Respond to feedback

Co-authored-by: Ansis Brammanis <ansis@mapbox.com>

* Non-test content updates (#10868)

* GL-JS --> Mapbox GL JS

* GL JS --> Mapbox GL JS

* remove e.g.

* remove i.e.

* Update src/ui/camera.js

* Resolves  `eslint-plugin-jsdoc` test failures  (#10858)

* Adds 'resource type' prefix for related items in GL JS API docs (#10837)
Co-authored-by: Asheem Mamoowala <asheem.mamoowala@mapbox.com>
Co-authored-by: Heather Stenson <heather.stenson@mapbox.com>
Co-authored-by: Karim Naaji <karim.naaji@gmail.com>
Co-authored-by: Arindam Bose <arindam.bose@mapbox.com>
Co-authored-by: Aidan H <aidan.hendrickson@mapbox.com>

* `jsdoc/check-types` linting (#10864)

* `jsdoc/check-types` linting: `Object` -> `object`
* Back to `Object` :|

* remove tests: check-indentation, check-alignment, check-tag-names, no-bad-blocks, valid-types, require-throws

* fix check-line-alignment and turn almost all tests to error

* change require-param-type to warn and fix that pesky sentence

* `jsdoc/require-param-type` linting (#10867)

* `jsdoc/require-param-type` linting

* Switch `Callback` to `Function` as per other callbacks defined in map.js

* Pin chrome to version 91 (#10887)

* Pin to chrome version 91

* Pin chrome version for test-browser

Co-authored-by: Dom Brassey <dom.brassey@mapbox.com>

* Add default values to some map API methods (#10823)

* Add default values to map methods

* Add default style value

* Add customAttribution default

* Add default value for container

* do not represent container as optional with value null

* do not represent style as optional with value null

* capitalize first letter

Co-authored-by: Dom Brassey <dom.brassey@mapbox.com>
Co-authored-by: HeyStenson <heather.stenson@mapbox.com>

* "jsdoc/require-property-description" rule and fixes to events.js (#10870)

* Merging

* Removed changes created by VSCode ESLint extension

* Update src/style/style_image.js

* object to Object and ryan's nits

* Update src/ui/events.js

Co-authored-by: Katy DeCorah <decorah@mapbox.com>

* Update src/style/style_image.js

Co-authored-by: Katy DeCorah <decorah@mapbox.com>

* Update src/style/style_image.js

Co-authored-by: Ricky Reusser <rreusser@users.noreply.github.com>

* Update src/ui/events.js

Co-authored-by: Ricky Reusser <rreusser@users.noreply.github.com>

* Update src/ui/events.js

Co-authored-by: Ricky Reusser <rreusser@users.noreply.github.com>

Co-authored-by: Dom Brassey <dom.brassey@mapbox.com>
Co-authored-by: Katy DeCorah <decorah@mapbox.com>
Co-authored-by: Ricky Reusser <rreusser@users.noreply.github.com>

* remove straggler instance of @Property {MapTouchEvent} data

* change 2 tests from warn to error

* Break down map methods and events into sections for docs (#10844)

* add map source sections, reorder some methods

* map sections fixes

* Fix @section causing `jsdoc/require-description-complete-sentence` to fail

* Cleanup reordered `events`

Co-authored-by: Arindam Bose <arindam.bose@mapbox.com>

* Apply suggestions from code review

* Update src/ui/map.js

* Update src/ui/map.js

* Update src/ui/map.js

* Update src/ui/map.js

* Update src/source/vector_tile_source.js

Co-authored-by: Dan Swick <dan.swick@gmail.com>

* Update src/geo/transform.js

Co-authored-by: Aidan H <aidan.hendrickson@mapbox.com>

Co-authored-by: Dom Brassey <dom.brassey@mapbox.com>
Co-authored-by: Ansis Brammanis <ansis@mapbox.com>
Co-authored-by: Karim Naaji <karim.naaji@gmail.com>
Co-authored-by: Ryan Hamley <ryan.hamley@mapbox.com>
Co-authored-by: Arindam Bose <arindam.bose@mapbox.com>
Co-authored-by: Ricky Reusser <rreusser@users.noreply.github.com>
Co-authored-by: Aidan H <aidan.hendrickson@mapbox.com>
Co-authored-by: Katy DeCorah <decorah@mapbox.com>
Co-authored-by: Vladimir Agafonkin <agafonkin@gmail.com>
Co-authored-by: Dan Swick <dan.swick@gmail.com>
arindam1993 pushed a commit that referenced this pull request Jul 30, 2021
@HeyStenson @ansis
@karimnaaji @rreusser @SnailBones @mourner @danswick
Add and update ESLint tests for Mapbox GL JS API docs (#10707)
a65a1a4 
* mapeventdata --> mapdataevent

* added require-property

* change warns to fails

* update tests

* ALL THE TESTS

* restore events.js

* updates and upgrades

* increase rigor of tests

* fix eslint errors for jsdoc examples (#10847)

* Add a few more examples (#10850)

* Add a few examples

* Update src/geo/mercator_coordinate.js

Co-authored-by: Ansis Brammanis <ansis@mapbox.com>

Co-authored-by: Ansis Brammanis <ansis@mapbox.com>

* Add some docs example (#10859)

* `require-example` linting (#10855)

* Add geojson source examples

* Add src/source/* inline examples

* Linter

* Lint

* Add camera examples

* Fixup

* Add camera examples

* Review comments

* Minor nit

* Apply jsdoc eslint rules only to public API files (#10854)

* `require-example` linting  (#10862)

* Last public facing examples

* Exclude private files from geo/ and promote require-example from warning to error

* `jsdoc/newline-after-description` linting (#10863)

* Update doc comments to conform to eslint-complete-sentences rule (#10851)

* Update doc comments to conform to eslint-complete-sentences rule

* Fix typo

* more detailed docs for return `this`

Extracted from Arindam's #10848

* Fix docs language

* Make complete-sentences an error

* Update eslintrc

* Cleanup

* Respond to feedback

Co-authored-by: Ansis Brammanis <ansis@mapbox.com>

* Non-test content updates (#10868)

* GL-JS --> Mapbox GL JS

* GL JS --> Mapbox GL JS

* remove e.g.

* remove i.e.

* Update src/ui/camera.js

* Resolves  `eslint-plugin-jsdoc` test failures  (#10858)

* Adds 'resource type' prefix for related items in GL JS API docs (#10837)
Co-authored-by: Asheem Mamoowala <asheem.mamoowala@mapbox.com>
Co-authored-by: Heather Stenson <heather.stenson@mapbox.com>
Co-authored-by: Karim Naaji <karim.naaji@gmail.com>
Co-authored-by: Arindam Bose <arindam.bose@mapbox.com>
Co-authored-by: Aidan H <aidan.hendrickson@mapbox.com>

* `jsdoc/check-types` linting (#10864)

* `jsdoc/check-types` linting: `Object` -> `object`
* Back to `Object` :|

* remove tests: check-indentation, check-alignment, check-tag-names, no-bad-blocks, valid-types, require-throws

* fix check-line-alignment and turn almost all tests to error

* change require-param-type to warn and fix that pesky sentence

* `jsdoc/require-param-type` linting (#10867)

* `jsdoc/require-param-type` linting

* Switch `Callback` to `Function` as per other callbacks defined in map.js

* Pin chrome to version 91 (#10887)

* Pin to chrome version 91

* Pin chrome version for test-browser

Co-authored-by: Dom Brassey <dom.brassey@mapbox.com>

* Add default values to some map API methods (#10823)

* Add default values to map methods

* Add default style value

* Add customAttribution default

* Add default value for container

* do not represent container as optional with value null

* do not represent style as optional with value null

* capitalize first letter

Co-authored-by: Dom Brassey <dom.brassey@mapbox.com>
Co-authored-by: HeyStenson <heather.stenson@mapbox.com>

* "jsdoc/require-property-description" rule and fixes to events.js (#10870)

* Merging

* Removed changes created by VSCode ESLint extension

* Update src/style/style_image.js

* object to Object and ryan's nits

* Update src/ui/events.js

Co-authored-by: Katy DeCorah <decorah@mapbox.com>

* Update src/style/style_image.js

Co-authored-by: Katy DeCorah <decorah@mapbox.com>

* Update src/style/style_image.js

Co-authored-by: Ricky Reusser <rreusser@users.noreply.github.com>

* Update src/ui/events.js

Co-authored-by: Ricky Reusser <rreusser@users.noreply.github.com>

* Update src/ui/events.js

Co-authored-by: Ricky Reusser <rreusser@users.noreply.github.com>

Co-authored-by: Dom Brassey <dom.brassey@mapbox.com>
Co-authored-by: Katy DeCorah <decorah@mapbox.com>
Co-authored-by: Ricky Reusser <rreusser@users.noreply.github.com>

* remove straggler instance of @Property {MapTouchEvent} data

* change 2 tests from warn to error

* Break down map methods and events into sections for docs (#10844)

* add map source sections, reorder some methods

* map sections fixes

* Fix @section causing `jsdoc/require-description-complete-sentence` to fail

* Cleanup reordered `events`

Co-authored-by: Arindam Bose <arindam.bose@mapbox.com>

* Apply suggestions from code review

* Update src/ui/map.js

* Update src/ui/map.js

* Update src/ui/map.js

* Update src/ui/map.js

* Update src/source/vector_tile_source.js

Co-authored-by: Dan Swick <dan.swick@gmail.com>

* Update src/geo/transform.js

Co-authored-by: Aidan H <aidan.hendrickson@mapbox.com>

Co-authored-by: Dom Brassey <dom.brassey@mapbox.com>
Co-authored-by: Ansis Brammanis <ansis@mapbox.com>
Co-authored-by: Karim Naaji <karim.naaji@gmail.com>
Co-authored-by: Ryan Hamley <ryan.hamley@mapbox.com>
Co-authored-by: Arindam Bose <arindam.bose@mapbox.com>
Co-authored-by: Ricky Reusser <rreusser@users.noreply.github.com>
Co-authored-by: Aidan H <aidan.hendrickson@mapbox.com>
Co-authored-by: Katy DeCorah <decorah@mapbox.com>
Co-authored-by: Vladimir Agafonkin <agafonkin@gmail.com>
Co-authored-by: Dan Swick <dan.swick@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SnailBones SnailBones SnailBones approved these changes

@HeyStenson HeyStenson HeyStenson approved these changes

Assignees
No one assigned
Labels
docs 📜 skip changelog Used for PRs that do not need a changelog entry
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@domlet @HeyStenson @SnailBones