Skip to content

docs: add @since tags to exports#1089

Merged
cowboyd merged 1 commit intothefrontside:v4from
alexvyber:since-tag-every-api-method
Feb 18, 2026
Merged

docs: add @since tags to exports#1089
cowboyd merged 1 commit intothefrontside:v4from
alexvyber:since-tag-every-api-method

Conversation

@alexvyber
Copy link
Collaborator

@alexvyber alexvyber commented Jan 27, 2026

Closes #1039
Adds @since tags to exports

@pkg-pr-new
Copy link

pkg-pr-new bot commented Jan 27, 2026

Open in StackBlitz

npm i https://pkg.pr.new/thefrontside/effection@1089

commit: bee31ab

Copy link
Member

@cowboyd cowboyd left a comment

Choose a reason for hiding this comment

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

Here are a couple of tweaks:

  1. Let's only use the major minor version since those are the only meaningful semver points that can introduce or change an api. I.e. instead of since @effection-v3.0.1, just @since 3.1
  2. I've noted it in a couple of places, but it looks as though the version is not correct. In fact, it appears that all of the versions are either 3.0 or 4.0 which means we're losing something somewhere. For example, the scoped API was introduced in v3.2.0
  3. For interface that have methods like Scope, we need to include their methods. For example Scope.run() was introduced in 3.0, but Scope.spawn() not until 3.5

@taras
Copy link
Member

taras commented Feb 13, 2026

@alexvyber you've done all of the heavy lifting here. I don't want to rush you, but I do want to extend an hand in case you need help driving this over the finish line. Please let me know if there is anything I can do to help.

@cowboyd cowboyd force-pushed the since-tag-every-api-method branch from 87a2560 to 4c6ae23 Compare February 18, 2026 18:05
@cowboyd cowboyd self-requested a review February 18, 2026 18:06
@cowboyd cowboyd force-pushed the since-tag-every-api-method branch from 4c6ae23 to bd64c8d Compare February 18, 2026 18:35
@cowboyd cowboyd force-pushed the since-tag-every-api-method branch from bd64c8d to bee31ab Compare February 18, 2026 18:36
@cowboyd cowboyd merged commit d7870b2 into thefrontside:v4 Feb 18, 2026
10 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.

Mark every API method, in both v3 and v4 as having "since" tag

3 participants

Comments