docs: Update API versioning doc #4311
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughRevised, the documentation is, to clarify ACTS versioning and public API policy. Now, the entire top-level Changes
Suggested labels
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
docs/versioning.rst (5)
11-13: Remove redundant “so” for clarity
“Since ACTS is still under active development, so we create…” Awkward phrasing, this is. Delete “so” to improve readability.
18-18: Clarify ‘Acts’ namespace phrasing
“Everything at the top-level in theActsis considered public.” Better specify “in theActsnamespace” to be precise.
20-22: Fix duplicated article ‘a’
“If a private a symbol…” Duplicate “a” there is. Remove one to correct the sentence.
24-29: Consistent code formatting for plugins
Plugin names listed without code markup are. For consistency, wrap each in double backticks, e.g.:- ``DD4hep`` - ``Json`` - ``TGeo`` - ``FpeMonitoring``
37-39: Standardize directory naming style
You use both “Plugins/folder” and “Pluginsdirectory.” Consistent style adopt you must: either include trailing slash everywhere or omit it.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/versioning.rst(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (19)
- GitHub Check: merge-sentinel
- GitHub Check: CI Bridge / lcg_107: [alma9, clang19]
- GitHub Check: CI Bridge / lcg_107: [alma9, gcc13]
- GitHub Check: CI Bridge / lcg_107: [alma9, gcc14]
- GitHub Check: CI Bridge / lcg_106a: [alma9, gcc13]
- GitHub Check: CI Bridge / lcg_106a: [alma9, clang16]
- GitHub Check: CI Bridge / lcg_106a: [alma9, gcc14]
- GitHub Check: CI Bridge / lcg_105: [alma9, clang16]
- GitHub Check: CI Bridge / linux_ubuntu_2204
- GitHub Check: CI Bridge / linux_ubuntu_2404_clang19
- GitHub Check: CI Bridge / lcg_105: [alma9, gcc13]
- GitHub Check: CI Bridge / build_linux_ubuntu
- GitHub Check: CI Bridge / build_exatrkx_cpu
- GitHub Check: CI Bridge / build_gnn_tensorrt
- GitHub Check: CI Bridge / build_exatrkx
- GitHub Check: CI Bridge / clang_tidy
- GitHub Check: unused_files
- GitHub Check: missing_includes
- GitHub Check: docs
|
See #4310 |
Co-authored-by: Alexander J. Pfleger <[email protected]> Co-authored-by: Benjamin Huth <[email protected]>
| If a private a symbol, e.g. in a the `Acts::detail` or `Acts::Experimental` namespaces | ||
| is part of an otherwise public API, this should be **considered a bug**, which we'd | ||
| appreciate being reported as an issue. |
There was a problem hiding this comment.
| If a private a symbol, e.g. in a the `Acts::detail` or `Acts::Experimental` namespaces | |
| is part of an otherwise public API, this should be **considered a bug**, which we'd | |
| appreciate being reported as an issue. | |
| If a private symbol, e.g. in the `Acts::detail` or `Acts::Experimental` namespaces, | |
| is part of an otherwise public API, this should be **considered a bug**, which we | |
| would appreciate being reported as an issue. |
--- END COMMIT MESSAGE ---
Any further description goes here, @-mentions are ok here!
feat,fix,refactor,docs,choreandbuildtypes.Summary by CodeRabbit