Skip to content

Document experimental attributes for Aspire.Hosting.Python #1880

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Oct 23, 2024
Merged

Document experimental attributes for Aspire.Hosting.Python #1880

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc9a5e4
Document experimental attributes for Aspire.hosting.Python
sebastienros Oct 22, 2024
fb4dda4
Use NoWarn instead of SuppressMessage
sebastienros Oct 23, 2024
2e3d821
changed wrong diagnostics
sebastienros Oct 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/diagnostics/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,23 @@ Alternatively, you can suppress this diagnostic with preprocessor directive by a
// API that is causing the warning.
#pragma warning restore ASPIREACADOMAINS001
```

## ASPIREHOSTINGPYTHON001

.NET Aspire provides a way to add Python executables or applications to the .NET Aspire app host. Since the shape of this API is expected to change in the future, it has been marked as _Experimental_. To suppress the compiler error/warning use the following code:

To suppress this diagnostic with the `SuppressMessageAttribute`, add the following code to your project file:

```xml
<PropertyGroup>
<NoWarn>$(NoWarn);ASPIREHOSTINGPYTHON001</NoWarn>
<PropertyGroup>
```

Alternatively, you can suppress this diagnostic with preprocessor directive by adding the following code to your project:

```csharp
#pragma warning disable ASPIREHOSTINGPYTHON001
// API that is causing the warning.
#pragma warning restore ASPIREHOSTINGPYTHON001
```
Loading