Skip to content
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

Feature: Add changelog support in the #[since()] macro #1309

Merged
merged 1 commit into from
Jan 27, 2025

Conversation

drmingdrmer
Copy link
Member

@drmingdrmer drmingdrmer commented Jan 26, 2025

Changelog

Feature: Add changelog support in the #[since()] macro

This commit introduces the ability to include changelogs directly in the
#[since()] macro. For example:

#[since(version = "0.1.0", change = "add new argument `a: u64`", change = "add T")]

Generates the following documentation line:

/// Since: 0.1.0: add new argument `a: u64`; add T

Key updates:

  • Multiple change attributes are supported within the same #[since()] macro.
  • Changelogs are concatenated into a single documentation line.

This enhancement makes it easier to document changes alongside version annotations.


This change is Reviewable

@drmingdrmer drmingdrmer requested a review from SteveLauC January 26, 2025 10:45
@drmingdrmer drmingdrmer force-pushed the 173-since-add-change-log branch from 4165f74 to 09a8e63 Compare January 27, 2025 01:02
This commit introduces the ability to include changelogs directly in the
`#[since()]` macro. For example:

```rust
#[since(version = "0.1.0", change = "add new argument `a: u64`", change = "add T")]
```

Generates the following documentation line:

```rust
/// Since: 0.1.0: add new argument `a: u64`; add T
```

Key updates:

- Multiple `change` attributes are supported within the same `#[since()]` macro.
- Changelogs are concatenated into a single documentation line.

This enhancement makes it easier to document changes alongside version annotations.
@drmingdrmer drmingdrmer force-pushed the 173-since-add-change-log branch from 09a8e63 to eef79b3 Compare January 27, 2025 05:05
@drmingdrmer drmingdrmer merged commit c6a0174 into databendlabs:main Jan 27, 2025
33 checks passed
@drmingdrmer drmingdrmer deleted the 173-since-add-change-log branch January 27, 2025 08:01
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.

1 participant