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

Flesh out metadata doc schema example #2146

Merged
merged 1 commit into from
Sep 20, 2024

Conversation

hyanwong
Copy link
Member

@hyanwong hyanwong commented Mar 7, 2022

As discussed with @benjeffery

@codecov
Copy link

codecov bot commented Mar 7, 2022

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.72%. Comparing base (a0baaaf) to head (051b324).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2146   +/-   ##
=======================================
  Coverage   89.72%   89.72%           
=======================================
  Files          29       29           
  Lines       31567    31573    +6     
  Branches     6113     6115    +2     
=======================================
+ Hits        28322    28328    +6     
  Misses       1853     1853           
  Partials     1392     1392           
Flag Coverage Δ
c-tests 86.55% <ø> (ø)
lwt-tests 80.78% <ø> (ø)
python-c-tests 88.98% <ø> (ø)
python-tests 99.01% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

Copy link
Member

@jeromekelleher jeromekelleher left a comment

Choose a reason for hiding this comment

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

LGTM, but I'd choose a different example in case people think this is the recommended route for location info.

docs/metadata.md Outdated Show resolved Hide resolved
@benjeffery
Copy link
Member

Thanks @hyanwong, looks good modulo JK's comments.
One more detail i should comment on - additionalProperties is optional here as it will be added to the schema for you if you use struct. The same thing is happening with required which is being set on the location object in this case.

@hyanwong
Copy link
Member Author

hyanwong commented Mar 8, 2022

OK, changed to height and age. I left a default for both there, as this is not an obvious thing to be able to do, so having an example is helpful, I think, even though the two values are basically independent.

docs/metadata.md Outdated Show resolved Hide resolved
docs/metadata.md Outdated Show resolved Hide resolved
@hyanwong hyanwong force-pushed the metadata-doc-extra branch 2 times, most recently from 8362d07 to e1e90ea Compare July 25, 2023 20:12
@hyanwong
Copy link
Member Author

This is now ready for merging, IMO, @benjeffery

@benjeffery
Copy link
Member

@Mergifyio rebase

@mergify
Copy link
Contributor

mergify bot commented Jul 26, 2023

rebase

✅ Nothing to do for rebase action

@benjeffery
Copy link
Member

Yeesh 32bit tests are failing hard. Will investigate.

@benjeffery
Copy link
Member

@Mergifyio rebase

@mergify
Copy link
Contributor

mergify bot commented Sep 21, 2023

rebase

✅ Branch has been successfully rebased

@benjeffery benjeffery force-pushed the metadata-doc-extra branch 2 times, most recently from 0193d17 to f650f26 Compare September 21, 2023 14:28
@benjeffery benjeffery added the AUTOMERGE-REQUESTED Ask Mergify to merge this PR label Sep 21, 2023
@benjeffery benjeffery removed the AUTOMERGE-REQUESTED Ask Mergify to merge this PR label Sep 20, 2024
@benjeffery benjeffery added the AUTOMERGE-REQUESTED Ask Mergify to merge this PR label Sep 20, 2024
@benjeffery benjeffery merged commit cebf8a9 into tskit-dev:main Sep 20, 2024
19 of 21 checks passed
@mergify mergify bot removed the AUTOMERGE-REQUESTED Ask Mergify to merge this PR label Sep 20, 2024
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