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

json schema: use description #560

Merged
merged 1 commit into from
Feb 14, 2024

Conversation

tjhei
Copy link
Contributor

@tjhei tjhei commented Feb 13, 2024

VSCode uses "description" to show documentation and not "documentation". This seems to be the correct convention, see
https://json-schema.org/learn/miscellaneous-examples for example.

part of #552

VSCode uses "description" to show documentation and not "documentation".
This seems to be the correct convention, see
https://json-schema.org/learn/miscellaneous-examples for example.
@tjhei
Copy link
Contributor Author

tjhei commented Feb 13, 2024

note, we need to merge #556 and #557 and then update the schema output before merging this.

@MFraters where is the "documentation" tag used? I did not get any errors.

Copy link

codecov bot commented Feb 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a01bf98) 93.54% compared to head (fd6a979) 93.54%.
Report is 5 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #560   +/-   ##
=======================================
  Coverage   93.54%   93.54%           
=======================================
  Files          92       92           
  Lines        6340     6340           
=======================================
  Hits         5931     5931           
  Misses        409      409           
Files Coverage Δ
source/world_builder/types/array.cc 100.00% <100.00%> (ø)
source/world_builder/types/bool.cc 100.00% <100.00%> (ø)
source/world_builder/types/double.cc 100.00% <100.00%> (ø)
source/world_builder/types/object.cc 100.00% <100.00%> (ø)
source/world_builder/types/one_of.cc 100.00% <100.00%> (ø)
source/world_builder/types/plugin_system.cc 100.00% <100.00%> (ø)
source/world_builder/types/point.cc 100.00% <100.00%> (ø)
source/world_builder/types/segment.cc 100.00% <100.00%> (ø)
source/world_builder/types/string.cc 100.00% <100.00%> (ø)
source/world_builder/types/unsigned_int.cc 100.00% <100.00%> (ø)
... and 1 more

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a01bf98...fd6a979. Read the comment docs.

Copy link

Benchmark Main Feature Difference (99.9% CI)
Slab interpolation simple none 1.022 ± 0.006 (s=440) 1.024 ± 0.005 (s=442) +0.0% .. +0.3%
Slab interpolation curved simple none 1.027 ± 0.002 (s=446) 1.027 ± 0.002 (s=433) +0.0% .. +0.1%
Spherical slab interpolation simple none 1.262 ± 0.004 (s=358) 1.264 ± 0.044 (s=357) -0.5% .. +0.7%
Slab interpolation simple curved CMS 1.097 ± 0.003 (s=453) 1.099 ± 0.004 (s=369) +0.1% .. +0.3%
Spherical slab interpolation simple CMS 1.861 ± 0.005 (s=220) 1.859 ± 0.004 (s=266) -0.2% .. -0.1%
Spherical fault interpolation simple none 1.272 ± 0.008 (s=355) 1.273 ± 0.006 (s=355) -0.1% .. +0.2%
Cartesian min max surface 2.354 ± 0.023 (s=196) 2.359 ± 0.018 (s=188) -0.1% .. +0.5%
Spherical min max surface 7.343 ± 0.017 (s=68) 7.351 ± 0.014 (s=57) -0.0% .. +0.2%

Copy link
Member

@MFraters MFraters left a comment

Choose a reason for hiding this comment

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

I think it is just used in the declarations file and the schema file. But let's not update it in this pull request, but update it in a follow up pull request to #562.

@MFraters MFraters merged commit bc9dead into GeodynamicWorldBuilder:main Feb 14, 2024
33 of 34 checks passed
@tjhei tjhei deleted the schema-description branch February 14, 2024 01:59
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