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 documentation about default values for Label origins #12139

Merged
merged 1 commit into from
Aug 23, 2024

Conversation

anne-gropler
Copy link
Contributor

@anne-gropler anne-gropler commented Aug 20, 2024

Description

Updated the documentation to reflect the current default values for HorizontalOrigin and VerticalOrigin in Label.ConstructorOptions.

While working with labels, i noticed that the default values for HorizontalOrigin and VerticalOrigin are documented as CENTER in both Label.ConstructorOptions and LabelGraphics.ConstructorOptions. But this is only true for labels as entities (LabelGraphics with LabelVisualizer), but not true for labels as Label in a LabelCollection, which use VerticalOrigin.BASELINE and HorizontalOrigin.LEFT.

Testing plan

Look at the documentation for Label.html#.ConstructorOptions

Author checklist

  • I had previously submitted a Contributor License Agreement
  • I had previously 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 updated the inline documentation, and included code examples where relevant
  • I have performed a self-review of my code

Copy link

Thank you for the pull request, @anne-gropler!

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

@anne-gropler anne-gropler marked this pull request as ready for review August 20, 2024 13:39
@anne-gropler
Copy link
Contributor Author

I don't know why the test coverage fails regarding picking when I only changed the documentation. Any help here is appreciated.

@ggetz
Copy link
Contributor

ggetz commented Aug 21, 2024

Thanks @anne-gropler! This change looks good to me!

The test failure seems to be a false positive. I'm re-running it now.

@ggetz ggetz merged commit da27fe1 into CesiumGS:main Aug 23, 2024
4 checks passed
@ggetz
Copy link
Contributor

ggetz commented Aug 23, 2024

Merged! Thanks again @anne-gropler!

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.

2 participants