Skip to content

Initial C API documentation#3557

Merged
ramcdougal merged 3 commits into
masterfrom
capi-docs
Aug 4, 2025
Merged

Initial C API documentation#3557
ramcdougal merged 3 commits into
masterfrom
capi-docs

Conversation

@ramcdougal

Copy link
Copy Markdown
Member

No description provided.

@ramcdougal ramcdougal requested a review from noahsafar August 4, 2025 19:06
@github-actions

github-actions Bot commented Aug 4, 2025

Copy link
Copy Markdown
Contributor

✔️ 7c98b4d -> artifacts URL

@github-actions

github-actions Bot commented Aug 4, 2025

Copy link
Copy Markdown
Contributor

✔️ 7a55752 -> artifacts URL

@codecov

codecov Bot commented Aug 4, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 68.40%. Comparing base (c0b9eba) to head (67c66d4).
⚠️ Report is 48 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3557      +/-   ##
==========================================
- Coverage   68.42%   68.40%   -0.03%     
==========================================
  Files         684      684              
  Lines      116645   116645              
==========================================
- Hits        79818    79789      -29     
- Misses      36827    36856      +29     

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@azure-pipelines

Copy link
Copy Markdown

✔️ 7a55752 -> Azure artifacts URL

Comment thread docs/capi.rst Outdated
Comment thread docs/capi.rst Outdated
Comment thread docs/capi.rst Outdated
Comment thread docs/capi.rst Outdated
Comment thread docs/capi.rst Outdated
Comment thread docs/capi.rst Outdated
Comment thread docs/capi.rst
Comment thread docs/capi.rst Outdated
Comment thread docs/capi.rst Outdated
Comment thread docs/capi.rst Outdated

@noahsafar noahsafar left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Replaced "h." with "n." and fixed capitalization and punctuation. Also changed "nrn_pop_str" to "nrn_str_pop" in accordance with PR #3558.

…o changed "nrn_pop_str" to "nrn_str_pop" in accordance with PR #3558.
@sonarqubecloud

sonarqubecloud Bot commented Aug 4, 2025

Copy link
Copy Markdown

@github-actions

github-actions Bot commented Aug 4, 2025

Copy link
Copy Markdown
Contributor

✔️ 67c66d4 -> artifacts URL

@azure-pipelines

Copy link
Copy Markdown

✔️ 67c66d4 -> Azure artifacts URL

@ramcdougal ramcdougal requested a review from noahsafar August 4, 2025 21:19
@ramcdougal ramcdougal merged commit 9da4610 into master Aug 4, 2025
43 checks passed
@ramcdougal ramcdougal deleted the capi-docs branch August 4, 2025 21:26
@JCGoran

JCGoran commented Aug 5, 2025

Copy link
Copy Markdown
Collaborator

Since this doesn't use references to the actual implementation, it's bound to get out-of-date at some point. If the docstrings were right in the source (https://github.com/neuronsimulator/nrn/blob/master/src/nrniv/neuronapi.cpp), this can be prevented. Granted, Doxygen is a bit...let's say "more cumbersome to write" compared to RST, but at least there's no need keep the API docs up-to-date since that'd be automatic.
Note that I'm not the primary consumer of the API, so this is just a suggestion.

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