Repository navigation
Mark experimental API with .NET's [Experimental] attribute #2120
Description
amcli mcp marks a preliminary tool where a model reads it (#2113). The library's experimental API has nothing like it: MathS.ExperimentalFeatures says so in its name and its doc comment, and a caller's build never mentions it.
.NET has a marker for this, [Experimental("<id>")] in System.Diagnostics.CodeAnalysis. Measured with SDK 10.0.302, a member marked [Experimental("AM0001")] gives:
| caller | result |
|---|---|
| C#, net10.0 | error AM0001: "… is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed." |
| C#, netstandard2.0, with the attribute defined internally in the library's netstandard2.0 build | the same error |
| F#, net10.0 | warning FS0057, "This construct is experimental"; the build succeeds |
A C# caller opts in with #pragma warning disable AM0001 or <NoWarn>.
- Additive:
PiecewiseOver(Write an expression with floors and ceilings over a bounded range as the piecewise it is there #2102) is new in 2.7.0 and not yet released, so marking it breaks nobody. Experimental members added later would be marked from the start. - Breaking: the eleven members published in 2.6.0. Marking them fails every C# caller's build until the caller suppresses the diagnostic. Whether each is promoted, kept or removed is item 3 of Pending breakages: changes agreed or arguable that cannot ship before a major version #1019, so marking them belongs there.
Questions:
- Should experimental API carry
[Experimental], starting withPiecewiseOverbefore 2.7.0 ships? - One diagnostic ID for all of it, or one per feature, so that opting into one doesn't opt into the rest?
🤖 Generated with Claude Code
Activity