-
Notifications
You must be signed in to change notification settings - Fork 229
validate documentation in #[zenoh_macros::unstable] to avoid broken text
#2348
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
PR missing one of the required labels: {'ci', 'bug', 'dependencies', 'enhancement', 'internal', 'new feature', 'api-sync', 'breaking-change', 'documentation'} |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2348 +/- ##
==========================================
+ Coverage 71.88% 71.93% +0.05%
==========================================
Files 387 387
Lines 61972 61986 +14
==========================================
+ Hits 44546 44590 +44
+ Misses 17426 17396 -30 ☔ View full report in Codecov by Sentry. |
* remove `internal_config` feature * after-merge fix --------- Co-authored-by: Michael Ilyin <[email protected]>
|
PR missing one of the required labels: {'new feature', 'api-sync', 'ci', 'internal', 'enhancement', 'breaking-change', 'dependencies', 'documentation', 'bug'} |
|
PR missing one of the required labels: {'breaking-change', 'new feature', 'internal', 'documentation', 'enhancement', 'bug', 'api-sync', 'dependencies', 'ci'} |
This reverts commit 76f4007.
The macro
#[zenoh_macros::unstable]adds notification that the API is unstable after first line of the documentation.This causes 2 problems:
Both problems can be fixed by adding empty line after fist line of documentation. This logically separates first statement, then the "unstable notice" panel is inserted and other documentation with correctly parsed links follows.
This fix makes
#[zenoh_macros::unstable]display error if this rule is not followed🏷️ Label-Based Checklist
Based on the labels applied to this PR, please complete these additional requirements:
Labels:
enhancement✨ Enhancement Requirements
Since this PR enhances existing functionality:
Remember: Enhancements should not introduce new APIs or breaking changes.
Instructions:
- [ ]to- [x])This checklist updates automatically when labels change, but preserves your checked boxes.