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

Fix Billboard and Label id types #11979

Merged
merged 3 commits into from
May 16, 2024
Merged

Fix Billboard and Label id types #11979

merged 3 commits into from
May 16, 2024

Conversation

jjspace
Copy link
Contributor

@jjspace jjspace commented May 13, 2024

Description

The type for Billboard.id and Label.id were incorrectly assigned to string instead of any. This PR just fixes that

Issue number and link

Fixes #11973

Testing plan

  • run npm run build-docs and npm run build-ts
  • Check the docs for Billboard and Label and make sure the id is shown as an object
  • check the generated .d.ts files we generate and and show the id for each object is now any

Author checklist

  • I have submitted a Contributor License Agreement
  • I have added my name to CONTRIBUTORS.md
  • I have updated CHANGES.md with a short summary of my change
  • I have added or updated unit tests to ensure consistent code coverage
  • I have update the inline documentation, and included code examples where relevant
  • I have performed a self-review of my code

@jjspace jjspace requested a review from ggetz May 13, 2024 16:55
@jjspace jjspace changed the title Fix Billboard and Label id types Fix Billboard and Label id types May 13, 2024
Copy link

Thank you for the pull request, @jjspace!

✅ We can confirm we have a CLA on file for you.

@ggetz
Copy link
Contributor

ggetz commented May 13, 2024

While we typically use * instead of any, I just checked that these are interchangeable both by jsDoc standards and by the typescript conversion tool.

Though I'd argue that for consistency on the ref doc page itself, we should opt for * instead of any.

@jjspace
Copy link
Contributor Author

jjspace commented May 15, 2024

@ggetz updated to use *, please check again, I think it should be good to go

@ggetz
Copy link
Contributor

ggetz commented May 16, 2024

Thanks @jjspace !

@ggetz ggetz merged commit 67bb821 into main May 16, 2024
9 checks passed
@ggetz ggetz deleted the fix-id-types branch May 16, 2024 18:11
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.

Documentation / TypeScript definition error/regression
2 participants