Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: Replace FIXME placeholders with proper documentation (170/758)#237

Merged
vitenti merged 8 commits into
masterfrom
copilot/replace-fixmes-with-docs
Feb 9, 2026
Merged

docs: Replace FIXME placeholders with proper documentation (170/758)#237
vitenti merged 8 commits into
masterfrom
copilot/replace-fixmes-with-docs

Conversation

Copilot AI commented Feb 8, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Replaces FIXME placeholders in GTK-Doc comments with actual documentation. 170 of 758 FIXMEs addressed, prioritizing core cosmology functions and high-visibility API enums.

Changes

Core cosmology (nc_hicosmo.c, 83 FIXMEs)

  • Virtual function setters: parameter @f documented as "an implementation of X"
  • Cosmological functions: documented return values with LaTeX formulas
    • Derivatives: dH/dz, dE²/dz, d²E²/dz²
    • Parameters: deceleration q(z), jerk j(z), energy conditions
    • Neutrino: NMassNu(), MassNuInfo() with output parameter meanings

Model enums (28 FIXMEs)

  • nc_hicosmo_gcg.h: Chaplygin gas parameters with units
  • nc_hicosmo_idem2.h: IDEM2 parameters with units

Cross-correlation kernels (8 FIXMEs)

  • Galaxy bias parameters: magnification bias $s$, clustering bias $b(z)$
  • Lensing kernels: empty enum documentation

Observational data enums (21 FIXMEs)

  • nc_data_hubble.h: Dataset IDs (Simon2005, Stern2009, Riess, etc.)
  • nc_data_snia.h: SNIa compilations (Gold, Union, SNLS3, JLA, Pantheon, DES)

Pattern established

// Before
/**
 * @f: FIXME
 * FIXME
 */

// After  
/**
 * @f: an implementation of Omega_b0.
 * Sets the implementation of Omega_b0 to @f.
 */

Remaining work

588 FIXMEs in model implementations (130), LSS files (200), perturbations (60), and miscellaneous (198). Same patterns apply.

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI changed the title [WIP] Review documentation and replace FIXME placeholders docs: Replace FIXME placeholders with proper documentation (170/758) Feb 8, 2026
Copilot AI requested a review from vitenti February 8, 2026 19:26
@codecov

codecov Bot commented Feb 8, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 0% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 76.28%. Comparing base (50368fc) to head (a0a4542).
⚠️ Report is 11 commits behind head on master.

Files with missing lines Patch % Lines
numcosmo_py/generate_stubs.py 0.00% 5 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #237      +/-   ##
==========================================
- Coverage   76.34%   76.28%   -0.07%     
==========================================
  Files         616      616              
  Lines      102603   102603              
==========================================
- Hits        78334    78269      -65     
- Misses      24269    24334      +65

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@vitenti vitenti marked this pull request as ready for review February 8, 2026 23:47
@vitenti vitenti merged commit 11d275b into master Feb 9, 2026
14 of 16 checks passed
@vitenti vitenti deleted the copilot/replace-fixmes-with-docs branch February 9, 2026 00:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@vitenti vitenti vitenti approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@vitenti vitenti

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@vitenti