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

refactor(location): nearbyGPSCoordinate options #1682

Merged
merged 14 commits into from
Jan 2, 2023

Conversation

Shinigami92
Copy link
Member

@Shinigami92 Shinigami92 added c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs m: location Something is referring to the location module deprecation A deprecation was made in the PR labels Dec 25, 2022
@Shinigami92 Shinigami92 self-assigned this Dec 25, 2022
@Shinigami92
Copy link
Member Author

@ST-DDT while running pnpm run generate:api-docs I get an error

- nearbyGPSCoordinate
/home/shinigami/OpenSource/faker/scripts/apidoc/signature.ts:238
            (property.type as ReflectionType)?.declaration.signatures?.[0]
                                               ^

TypeError: Cannot read properties of undefined (reading 'signatures')
    at <anonymous> (/home/shinigami/OpenSource/faker/scripts/apidoc/signature.ts:238:48)
    at Array.map (<anonymous>)
    at analyzeParameterOptions (/home/shinigami/OpenSource/faker/scripts/apidoc/signature.ts:231:23)
    at <anonymous> (/home/shinigami/OpenSource/faker/scripts/apidoc/signature.ts:227:7)
    at Array.flatMap (<anonymous>)
    at analyzeParameterOptions (/home/shinigami/OpenSource/faker/scripts/apidoc/signature.ts:226:32)
    at analyzeParameter (/home/shinigami/OpenSource/faker/scripts/apidoc/signature.ts:210:22)
    at analyzeSignature (/home/shinigami/OpenSource/faker/scripts/apidoc/signature.ts:128:20)
    at processModuleMethod (/home/shinigami/OpenSource/faker/scripts/apidoc/moduleMethods.ts:77:18)
    at processModuleMethods (/home/shinigami/OpenSource/faker/scripts/apidoc/moduleMethods.ts:34:19)

can you help me fix this?

@ST-DDT
Copy link
Member

ST-DDT commented Dec 25, 2022

This error is shown if there is a param without jsdocs. We could try to improve the error message, but not sure what information we have in that context.

options vs optionsOrCoordinate

@codecov
Copy link

codecov bot commented Dec 25, 2022

Codecov Report

Merging #1682 (2bda9de) into next (59824e6) will decrease coverage by 0.00%.
The diff coverage is 89.47%.

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #1682      +/-   ##
==========================================
- Coverage   99.64%   99.63%   -0.01%     
==========================================
  Files        2245     2245              
  Lines      240318   240400      +82     
  Branches     1078     1079       +1     
==========================================
+ Hits       239453   239525      +72     
- Misses        844      854      +10     
  Partials       21       21              
Impacted Files Coverage Δ
src/modules/location/index.ts 97.92% <89.47%> (-1.86%) ⬇️

@Shinigami92
Copy link
Member Author

Shinigami92 commented Dec 25, 2022

This error is shown if there is a param without jsdocs. We could try to improve the error message, but not sure what information we have in that context.

options vs optionsOrCoordinate

I will extract to an issue

@Shinigami92 Shinigami92 marked this pull request as ready for review December 25, 2022 15:23
@Shinigami92 Shinigami92 requested a review from a team as a code owner December 25, 2022 15:23
@Shinigami92 Shinigami92 requested a review from a team December 25, 2022 15:24
@Shinigami92 Shinigami92 requested review from ST-DDT, a team and import-brain December 26, 2022 13:19
import-brain
import-brain previously approved these changes Dec 29, 2022
src/modules/location/index.ts Outdated Show resolved Hide resolved
src/modules/location/index.ts Outdated Show resolved Hide resolved
Co-authored-by: ST-DDT <ST-DDT@gmx.de>
Co-authored-by: Leyla Jähnig <leyla.jaehnig@gmx.de>
@Shinigami92 Shinigami92 enabled auto-merge (squash) January 2, 2023 14:25
@Shinigami92 Shinigami92 merged commit 496c40b into next Jan 2, 2023
@ST-DDT ST-DDT deleted the 1349-location-nearbyGPSCoordinate-options branch January 21, 2023 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs deprecation A deprecation was made in the PR m: location Something is referring to the location module
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants