Skip to content

Refactor documentation and code annotations to standardize '@need:' f… - #33

Merged
Rubyfi merged 3 commits into
mainfrom
feat/ubcode-sn-compatibility
Oct 15, 2026
Merged

Rubyfi merged 3 commits into
mainfrom
feat/ubcode-sn-compatibility

Conversation

@Rubyfi

@Rubyfi Rubyfi commented Oct 15, 2026

Copy link
Copy Markdown
Contributor

This pull request standardizes and clarifies the way code annotations for requirements ("needs") are written and referenced throughout the codebase and documentation. It also updates some documentation icons and cleans up configuration and JSON files for better maintainability and clarity.

The most important changes are:

Standardization of Code Annotations:

  • Updated all code comments that previously used @ to annotate needs (e.g., // @Test ...) to use the explicit @need: prefix for clearer parsing and consistency across all C++ source and test files (src/main.cpp, src/sample1.cpp, src/sample1_unittest.cpp, src/sample2.cpp). [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]

Documentation and Configuration Updates:

  • Updated all documentation and code examples to use the new @need: annotation style, including in how-to guides and configuration files (docs/how-to-guides/testing/index.rst, docs/how-to-guides/trace-code/index.rst, docs/ubproject.toml). [1] [2] [3] [4] [5]
  • Changed the configuration in ubproject.toml to match the new annotation style by setting start_sequence = "@need:" for code analysis.

Documentation Visual Improvements:

  • Updated several documentation section icons to use more appropriate or visually consistent Octicon icons (e.g., :octicon:book Reference, :octicon:workflow Draw.io Integration). [1] [2] [3] [4] [5]

Configuration and JSON Cleanup:

  • Simplified docs/external/needs_external.json by removing unused or empty fields from need entries, making the file cleaner and easier to maintain. [1] [2] [3] [4] [5]
  • Removed deprecated or commented-out sections from ubproject.toml for better clarity.

Minor Project Structure Adjustments:

  • Moved the project source directory configuration from [project] srcdir to a new [source] dir section in ubproject.toml for improved structure.

These changes collectively improve the consistency, clarity, and maintainability of both the codebase and its documentation.

@Rubyfi
Rubyfi requested a review from PhilipPartsch October 15, 2026 11:58
@Rubyfi
Rubyfi merged commit 5447062 into main Oct 15, 2026
2 checks passed
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