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

TSDocs lint #2804

Merged
merged 9 commits into from
Jul 5, 2023
Merged

TSDocs lint #2804

merged 9 commits into from
Jul 5, 2023

Conversation

HarelM
Copy link
Collaborator

@HarelM HarelM commented Jul 5, 2023

Fixes all the lint errors.
Added hyphen.
Changed all the @tags to be relevant.

@HarelM HarelM requested a review from birkskyum July 5, 2023 17:55
@HarelM HarelM mentioned this pull request Jul 5, 2023
src/style/style.ts Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (e3adb3c) 73.93% compared to head (c848058) 73.93%.

Additional details and impacted files
@@              Coverage Diff               @@
##           jsdocs-tsdocs    #2804   +/-   ##
==============================================
  Coverage          73.93%   73.93%           
==============================================
  Files                238      238           
  Lines              18968    18968           
  Branches            4281     4281           
==============================================
  Hits               14024    14024           
  Misses              4944     4944           
Impacted Files Coverage Δ
src/data/bucket.ts 92.85% <ø> (ø)
src/data/bucket/circle_bucket.ts 78.16% <ø> (ø)
src/data/bucket/line_bucket.ts 58.23% <ø> (ø)
src/data/bucket/symbol_bucket.ts 50.61% <ø> (ø)
src/data/evaluation_feature.ts 100.00% <ø> (ø)
src/data/extent.ts 100.00% <ø> (ø)
src/data/index_array_type.ts 100.00% <ø> (ø)
src/data/load_geometry.ts 100.00% <ø> (ø)
src/data/program_configuration.ts 32.28% <ø> (ø)
src/data/segment.ts 82.60% <ø> (ø)
... and 84 more

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

src/ui/events.ts Outdated Show resolved Hide resolved
src/ui/events.ts Outdated Show resolved Hide resolved
@HarelM HarelM merged commit 18fc811 into jsdocs-tsdocs Jul 5, 2023
12 checks passed
@HarelM HarelM deleted the tsdocs-lint branch July 5, 2023 19:30
HarelM added a commit that referenced this pull request Jul 8, 2023
* Some examples of conversion

* More experiments

* Fix group name

* Fix lint

* made basic UI changes (#2755)

* Move more comments to their right place

* Remove more tsdocs comments

* Fix lint, complete map jsdocs removal

* Fix lint, remove return types from jsdocs comments.

* Js ts controls (#2777)

* Fix some controls

* Replace jsdoc with tsdocs lint

* Fix control's jsdocs

* Improve the looks of the controls

* Fix lint and CI

* Remove the last jsdoc comments in geolocation control

* Introduce max canvas size option and automatically limit pixel ratio (#2674)

* rendering test: implement cropping of png result

This is useful for renderer results that are too large to be handled by puppeteer

* mock webgl: update drawing buffer size when viewport changes

* Round down painter and canvas dimensions so they're consistent

* add veryhigh pixel ratio test

This test draws a black square,
The pixel ratio and width were chosen to exceed the maximum texture value, which is set to 8192 in the CI environment.
The result is cropped due to the limits of the intercommunication between chromium and puppeteer.

* introduce maxCanvasSize option

A canvas size over GL MAX_TEXTURE_SIZE can cause distortions and an excessive canvas size can cause hangs or crashes.
Limiting canvas size can fix these issues. Add an option to let the users alter this limit.
The default value is [4096, 4096] as MAX_TEXTURE_SIZE is usally at least 4096px.
In CI max_texture_size is 8192, so we set maxCanvasSize to that value in tests.

* Resize map after setting pixel ratio

This has two benefits:
1. The map is immediately re-rendered with the new pixel ratio
2. We avoid duplicating pixel ratio clamping logic

* further clamp pixel ratio after hitting gl limits

Althoug setting maxCanvasSize to a value <= GL.MAX_TEXTURE_SIZE solves most problems, there is no guarantee that we cannot exceed other GL limits.
To handle these cases, we check that the drawing buffer is of the requested size, if it isn't we scale down pixel ratio further

* map test: move webgl error in its own section

* add a unit test for webgl drawing buffer limits

* update maxCanvasSize type and change comment type

* update maxCanvasSize after hitting gl limits

This is an optimization to avoid failing the overlimit check multiple times.

* update changelog

* Added handlers to the docs (#2778)

* Added handlers to the docs

* Fix lint

* Small changes to the docs contribution guide (#2791)

* Changes to docs contribution

* don't link for better review

* Migrated popup and marker (#2790)

* Migrated marker and popup

* Fix lint

* Code review fixes

* Added missing marker options object

* Fix lint and tests

* Fix typo

* remove unneeded lint comment.

* Bump typescript from 5.1.5 to 5.1.6 (#2787)

Bumps [typescript](https://github.com/Microsoft/TypeScript) from 5.1.5 to 5.1.6.
- [Release notes](https://github.com/Microsoft/TypeScript/releases)
- [Commits](https://github.com/Microsoft/TypeScript/commits)

---
updated-dependencies:
- dependency-name: typescript
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Fix sources (#2795)

* Fix sources

* Added typedoc

* Fix custom style layer

* Fix test, add comments

* fix grammer spelling

* More minor fixes

* JSDocs TSDocs leftovers (#2801)

* insets, lnglat+bounds

* mercator

* transform

* draw_terrain

* line_atlas

* terrain

* tile, styel_image

* actore

* ajax

* image request queue

* struct array

* Remove returns objects

* typedef

* remove function

* Removed some prperties

* Fix lint

* Fix tests

* Lint, cr fixes

* TSDocs JSDocs migration: build warning removal (#2802)

* Added comments to reduce warnings

* Fix most of the warnings in the build process

* TSDocs lint (#2804)

* Move all examples to be tripple slash, hypen, remove @Private

* delimiter fix

* More fixes

* Fix lint

* Remove unneeded rule

* Code review changes.

* Fix var let bad replacenment

* Fix typo

* Fix bwc address

* Small fixes to the event related docs

* Fix lint

* Fix the event related issue

* Added Geography and Geometry group (#2808)

* Added Geography and Geometry

* Fix lint

* Finished the event documentation

* Fix lint

* Main docs readme links fixes and CI (#2813)

* Fix main readme links

* make links relative

* More readme fixes

* Adding build to CI

* Simplify docker commend

* Change site url in the config to match the expected production site.

* Added CI part

* Final small fixes.

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Krishna Lodha <47075664+krishnaglodha@users.noreply.github.com>
Co-authored-by: Andrea Mennillo <handymenny@outlook.com>
Co-authored-by: Birk Skyum <74932975+birkskyum@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants