Skip to content

Json struct c docs#3439

Open
petrelharp wants to merge 2 commits intotskit-dev:mainfrom
petrelharp:json-struct-c-docs
Open

Json struct c docs#3439
petrelharp wants to merge 2 commits intotskit-dev:mainfrom
petrelharp:json-struct-c-docs

Conversation

@petrelharp
Copy link
Contributor

@petrelharp petrelharp commented Mar 20, 2026

I think that removing the json+struct C code from tskit itself and providing an example in the C docs is probably the way to go. @bhaller provided the C code, modified from the method and tests in #3437.

Currently this has the additional docs that are also in #3440.

@codecov
Copy link

codecov bot commented Mar 20, 2026

Codecov Report

❌ Patch coverage is 0% with 84 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.68%. Comparing base (afaf3b9) to head (a8473fe).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3439      +/-   ##
==========================================
- Coverage   91.92%   91.68%   -0.24%     
==========================================
  Files          37       38       +1     
  Lines       32153    32237      +84     
  Branches     5143     5156      +13     
==========================================
  Hits        29556    29556              
- Misses       2264     2348      +84     
  Partials      333      333              
Flag Coverage Δ
C 82.30% <0.00%> (-0.41%) ⬇️
c-python 77.34% <ø> (ø)
python-tests 96.40% <ø> (ø)
python-tests-no-jit 33.22% <ø> (ø)

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

Components Coverage Δ
Python API 98.69% <ø> (ø)
Python C interface 91.23% <ø> (ø)
C library 88.42% <0.00%> (-0.44%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@petrelharp petrelharp force-pushed the json-struct-c-docs branch 2 times, most recently from f4ed750 to f1593cc Compare March 21, 2026 15:23
@petrelharp petrelharp marked this pull request as ready for review March 21, 2026 15:24
@petrelharp petrelharp force-pushed the json-struct-c-docs branch 2 times, most recently from 75037d5 to abaaa1d Compare March 22, 2026 03:39
@petrelharp
Copy link
Contributor Author

Codecov is complaining because the example C file is not being hit. AFAICT this is expected, and perhaps we should change this line to ask codecov to just cover c/tskit/ instead of c/?

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