Mark Aspire.Hosting.Python as experimental#6434
Conversation
There was a problem hiding this comment.
We also need to "stablize" the package again.
aspire/src/Aspire.Hosting.Python/Directory.Build.props
Lines 3 to 6 in a4ef97a
|
|
||
| using System.Diagnostics.CodeAnalysis; | ||
|
|
||
| [assembly: Experimental("ASPIREHOSTINGPYTHON001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")] |
There was a problem hiding this comment.
How do we get https://learn.microsoft.com/en-us/dotnet/aspire/diagnostics/overview#ASPIREHOSTINGPYTHON001 to be a valid URL?
cc @IEvangelist
There was a problem hiding this comment.
The ASPIREHOSTINGPYTHON001 has to either be a heading, or you can use an inline named HTML element:
<span name="ASPIREHOSTINGPYTHON001"></span>Then the bookmark will work.
There was a problem hiding this comment.
@IEvangelist when I create the doc I use a heading, same as the other sections, but the generated id is lower-cased so the current link doesn't work. I will add the this way there is no change to do in aspire, but it's unfortunate. Maybe the doc generator could also inject a name with the actual case of the heading (though that would leak everywhere).
There was a problem hiding this comment.
Yeah, that's a dotnet/docfx concern more than anything else. Bookmarks in URLs just look better in lowercase in my opinion, but knowing that they're always in lowercase, why not just have this code ensure that they're lowercase?
There was a problem hiding this comment.
I agree, had I known I would have done it before. But I don't want to block release/9.0 insertion on that. Will do it in main once 9.0 has shipped and is merged back.
eerhardt
left a comment
There was a problem hiding this comment.
Code change looks good to me. We will need to get the doc site updated for the new diagnostic.
|
/backport to release/9.0 |
|
Started backporting to release/9.0: https://github.com/dotnet/aspire/actions/runs/11484230088 |
@sebastienros can you please log an issue for this in the aspire-docs repo and paste it above in the PR description form? That way when filling that doc we'll have a link to the original PR. |
This happened with Document experimental attributes for Aspire.Hosting.Python (dotnet/docs-aspire#1880). |
Description
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes #6298
Diagnostic documented here dotnet/docs-aspire#1880
Checklist
<remarks />and<code />elements on your triple slash comments?Microsoft Reviewers: Open in CodeFlow