Skip to content

docs: add TraitDefinition and ebv_glossary API reference#82

Merged
zircote merged 1 commit intomainfrom
docs/add-mcp-analytics-api-reference-d3d3f83184f1891f
Feb 20, 2026
Merged

docs: add TraitDefinition and ebv_glossary API reference#82
zircote merged 1 commit intomainfrom
docs/add-mcp-analytics-api-reference-d3d3f83184f1891f

Conversation

@zircote
Copy link
Owner

@zircote zircote commented Feb 19, 2026

Summary

Adds missing public API documentation for mcp::analytics module items that were not previously documented in the Library API Reference.

Changes

Added documentation for two public items from crates/mcp/analytics.rs:

TraitDefinition struct

  • Documents all five fields with descriptions
  • Shows proper Rust type signatures (&'static str)
  • Provides example usage context

ebv_glossary() function

  • Documents the function signature and return type
  • Includes practical code example showing iteration over results
  • Cross-references the complete trait table in MCP.md#ebv-trait-glossary

Documentation Quality

  • Consistency: Follows existing patterns in LIBRARY-API.md (field tables, code examples, cross-references)
  • Completeness: All public API items in mcp::analytics are now documented
  • Accuracy: Documentation verified against source code in crates/mcp/analytics.rs:266-281
  • Discoverability: Cross-links to related MCP.md documentation

Testing

  • All public items from mcp::analytics verified as documented
  • Markdown syntax validated
  • Cross-reference anchors verified (#ebv-trait-glossary exists in MCP.md)
  • Code examples follow existing doc test patterns

Related

Complements recent PR #79 which added comprehensive MCP module documentation.


Documentation gap identified: These public exports were accessible via use nsip::mcp::analytics::{TraitDefinition, ebv_glossary}; but were undocumented in the reference manual.

AI generated by Update Docs

Document the missing public API items from mcp::analytics module:
- TraitDefinition struct with all fields
- ebv_glossary() function with usage example

These items are public exports from crates/mcp/analytics.rs
but were not previously documented in the Library API Reference.

Cross-reference to MCP.md for the complete trait glossary table.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@zircote zircote added automation documentation Improvements or additions to documentation labels Feb 19, 2026
@github-actions
Copy link
Contributor

Benchmark Results

No benchmarks configured. Add benchmarks to benches/ directory.

Full results available in CI artifacts.

@codecov
Copy link

codecov bot commented Feb 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.83%. Comparing base (47af4a3) to head (3bf2d67).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #82   +/-   ##
=======================================
  Coverage   95.83%   95.83%           
=======================================
  Files           9        9           
  Lines        6499     6499           
=======================================
  Hits         6228     6228           
  Misses        271      271           

☔ 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.

@github-actions
Copy link
Contributor

Code Coverage Report

Overall Coverage: 0%

Summary

Filename                      Regions    Missed Regions     Cover   Functions  Missed Functions  Executed       Lines      Missed Lines     Cover    Branches   Missed Branches     Cover
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
client.rs                        1444                67    95.36%         118                13    88.98%         923                35    96.21%           0                 0         -
format.rs                        2172                 3    99.86%         132                 1    99.24%        1292                 1    99.92%           0                 0         -
main.rs                           326               241    26.07%          14                 8    42.86%         225               168    25.33%           0                 0         -
mcp/analytics.rs                  408                 2    99.51%          24                 0   100.00%         331                 0   100.00%           0                 0         -
mcp/mod.rs                        144                55    61.81%          23                15    34.78%         128                65    49.22%           0                 0         -
mcp/prompts.rs                   1908                33    98.27%         126                 6    95.24%        1043                12    98.85%           0                 0         -
mcp/resources.rs                 1317                20    98.48%          93                 1    98.92%         865                 6    99.31%           0                 0         -
mcp/tools.rs                     2146                90    95.81%         116                18    84.48%        1333                47    96.47%           0                 0         -
models.rs                        1079                31    97.13%          78                10    87.18%         762                14    98.16%           0                 0         -
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                           10944               542    95.05%         724                72    90.06%        6902               348    94.96%           0                 0         -

Full HTML report available in CI artifacts.

@zircote zircote marked this pull request as ready for review February 19, 2026 13:47
Copilot AI review requested due to automatic review settings February 19, 2026 13:47
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds complete API reference documentation for the TraitDefinition struct and ebv_glossary() function in the mcp::analytics module, closing a documentation gap for public API items that were previously undocumented.

Changes:

  • Documents the TraitDefinition struct with all five fields and their types
  • Documents the ebv_glossary() function with signature, description, and usage example
  • Adds cross-reference to the complete trait table in MCP.md

@zircote zircote merged commit bb2f81c into main Feb 20, 2026
43 checks passed
@zircote zircote deleted the docs/add-mcp-analytics-api-reference-d3d3f83184f1891f branch February 20, 2026 03:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants