Clean-up
authorViktor Hofer <viktor.hofer@microsoft.com>
Mon, 18 Sep 2023 13:51:32 +0000 (15:51 +0200)
committerViktor Hofer <viktor.hofer@microsoft.com>
Mon, 18 Sep 2023 14:24:52 +0000 (16:24 +0200)
17 files changed:
src/libraries/Microsoft.Bcl.TimeProvider/src/PACKAGE.md
src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/PACKAGE.md
src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/PACKAGE.md
src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/PACKAGE.md
src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/PACKAGE.md
src/libraries/Microsoft.Extensions.Configuration.Ini/src/PACKAGE.md
src/libraries/Microsoft.Extensions.Configuration.Json/src/PACKAGE.md
src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/PACKAGE.md
src/libraries/Microsoft.Extensions.Configuration.Xml/src/PACKAGE.md
src/libraries/Microsoft.Extensions.DependencyModel/src/PACKAGE.md
src/libraries/Microsoft.Extensions.Hosting/src/PACKAGE.md
src/libraries/Microsoft.Extensions.Logging.Console/src/PACKAGE.md
src/libraries/System.Collections.Immutable/src/PACKAGE.md
src/libraries/System.Configuration.ConfigurationManager/src/PACKAGE.md
src/libraries/System.Reflection.Metadata/src/PACKAGE.md
src/libraries/System.Reflection.MetadataLoadContext/src/PACKAGE.md
src/libraries/System.Runtime.Caching/src/PACKAGE.md

index bf767f3354d39a383861ea6074538ae79eacef2d..f3c9c372cf2caf8b2515ef49b0526ffb099a847c 100644 (file)
@@ -52,7 +52,6 @@ The main types provided by this library are:
 
 * [API documentation](https://learn.microsoft.com/dotnet/api/system.timeprovider)
 
-
 ## Feedback & Contributing
 
 Microsoft.Bcl.TimeProvider is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
\ No newline at end of file
index 428cc0faf6b8e61aaad41e5c9c99f3e6a725a103..e744e1b9e73df12d2a9c19552aa9923483852f71 100644 (file)
@@ -4,7 +4,6 @@
 
 Provides abstractions of key-value pair based configuration. Interfaces defined in this package are implemented by classes in [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/) and other configuration packages.
 
-
 ## Key Features
 
 <!-- The key features of this package -->
@@ -44,7 +43,6 @@ var options = config.Get<MyClass>();
 Console.WriteLine(options.NamedProperty); // returns "value for named property"
 ```
 
-
 ## Main Types
 
 <!-- The main types provided in this library -->
index 91bcc9a646a50138e2f8d621c08519736e1fb708..8b1734c0421fb3a98257877c966f90f3a7d6a13d 100644 (file)
@@ -4,28 +4,6 @@
 
 Command line configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read configuration parameters from the command line arguments of your application. You can use [CommandLineConfigurationExtensions.AddCommandLine](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.commandlineconfigurationextensions.addcommandline) extension method on `IConfigurationBuilder` to add the command line configuration provider to the configuration builder.
 
-## Key Features
-
-<!-- The key features of this package -->
-
-*
-*
-*
-
-## How to Use
-
-<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
-
-## Main Types
-
-<!-- The main types provided in this library -->
-
-The main types provided by this library are:
-
-* ``
-* ``
-* ``
-
 ## Additional Documentation
 
 <!-- Links to further documentation -->
@@ -33,10 +11,6 @@ The main types provided by this library are:
 * [Command-line configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#command-line-configuration-provider)
 * [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.commandline)
 
-## Related Packages
-
-<!-- The related packages associated with this package -->
-
 ## Feedback & Contributing
 
 <!-- How to provide feedback on this package and contribute to it -->
index 3363278a0108c0be1d73db2fb84220f7848940eb..eb9a67bfbfda25ab9f26a07571670aacb0311cc0 100644 (file)
@@ -4,14 +4,6 @@
 
 Environment variables configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read configuration parameters from environment variables. You can use [EnvironmentVariablesExtensions.AddEnvironmentVariables](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.environmentvariablesextensions.addenvironmentvariables) extension method on `IConfigurationBuilder` to add the environment variables configuration provider to the configuration builder.
 
-## Key Features
-
-<!-- The key features of this package -->
-
-*
-*
-*
-
 ## How to Use
 
 <!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
@@ -38,16 +30,6 @@ class Program
 }
 ```
 
-## Main Types
-
-<!-- The main types provided in this library -->
-
-The main types provided by this library are:
-
-* ``
-* ``
-* ``
-
 ## Additional Documentation
 
 <!-- Links to further documentation -->
@@ -55,10 +37,6 @@ The main types provided by this library are:
 * [Environment variable configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#environment-variable-configuration-provider)
 * [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.environmentvariables)
 
-## Related Packages
-
-<!-- The related packages associated with this package -->
-
 ## Feedback & Contributing
 
 <!-- How to provide feedback on this package and contribute to it -->
index 60b2096828e8ecb2c1925e9210e404ea123c99fb..4a4f404102c89ad562982119d877dc531e51a25c 100644 (file)
@@ -4,28 +4,6 @@
 
 Provides a base class for file-based configuration providers used with [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/) and extension methods for configuring them.
 
-## Key Features
-
-<!-- The key features of this package -->
-
-*
-*
-*
-
-## How to Use
-
-<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
-
-## Main Types
-
-<!-- The main types provided in this library -->
-
-The main types provided by this library are:
-
-* ``
-* ``
-* ``
-
 ## Additional Documentation
 
 <!-- Links to further documentation -->
@@ -34,10 +12,6 @@ The main types provided by this library are:
 * [Microsoft.Extensions.Configuration.FileConfigurationProvider](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.fileconfigurationprovider)
 * [Microsoft.Extensions.Configuration.FileConfigurationExtensions](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.fileconfigurationextensions)
 
-## Related Packages
-
-<!-- The related packages associated with this package -->
-
 ## Feedback & Contributing
 
 <!-- How to provide feedback on this package and contribute to it -->
index 1a32dfbb88ab79d68250d63f921cb345841f37cd..0fc660489a4fc6b9a4e6af0e47fba6395a54425a 100644 (file)
@@ -4,28 +4,6 @@
 
 INI configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read configuration parameters from [INI files](https://en.wikipedia.org/wiki/INI_file). You can use [IniConfigurationExtensions.AddIniFile](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iniconfigurationextensions.addinifile) extension method on `IConfigurationBuilder` to add INI configuration provider to the configuration builder.
 
-## Key Features
-
-<!-- The key features of this package -->
-
-*
-*
-*
-
-## How to Use
-
-<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
-
-## Main Types
-
-<!-- The main types provided in this library -->
-
-The main types provided by this library are:
-
-* ``
-* ``
-* ``
-
 ## Additional Documentation
 
 <!-- Links to further documentation -->
@@ -33,10 +11,6 @@ The main types provided by this library are:
 * [INI configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#ini-configuration-provider)
 * [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.ini)
 
-## Related Packages
-
-<!-- The related packages associated with this package -->
-
 ## Feedback & Contributing
 
 <!-- How to provide feedback on this package and contribute to it -->
index 777a3420ad3319c0f7d1395b833792a5ad09f2a7..825b3dbe412d4da4584069a7f543295700641f75 100644 (file)
@@ -4,14 +4,6 @@
 
 JSON configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read your application's settings from a JSON file. You can use [JsonConfigurationExtensions.AddJsonFile](https://docs.microsoft.com/dotnet/api/microsoft.extensions.configuration.jsonconfigurationextensions.addjsonfile) extension method on `IConfigurationBuilder` to add the JSON configuration provider to the configuration builder.
 
-## Key Features
-
-<!-- The key features of this package -->
-
-*
-*
-*
-
 ## How to Use
 
 <!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
@@ -72,16 +64,6 @@ You can include a configuration file using a code like this in your `.csproj` fi
 </ItemGroup>
 ```
 
-## Main Types
-
-<!-- The main types provided in this library -->
-
-The main types provided by this library are:
-
-* ``
-* ``
-* ``
-
 ## Additional Documentation
 
 <!-- Links to further documentation -->
@@ -89,10 +71,6 @@ The main types provided by this library are:
 * [JSON configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#json-configuration-provider)
 * [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.json)
 
-## Related Packages
-
-<!-- The related packages associated with this package -->
-
 ## Feedback & Contributing
 
 <!-- How to provide feedback on this package and contribute to it -->
index 12ec8f399a912008c3014c67e5b51601d3f3951b..1fe9ee6c98939eca5954fc741622c648c8a1e555 100644 (file)
@@ -4,28 +4,6 @@
 
 User secrets configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). User secrets mechanism enables you to override application configuration settings with values stored in the local secrets file. You can use [UserSecretsConfigurationExtensions.AddUserSecrets](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.usersecretsconfigurationextensions.addusersecrets) extension method on `IConfigurationBuilder` to add user secrets provider to the configuration builder.
 
-## Key Features
-
-<!-- The key features of this package -->
-
-*
-*
-*
-
-## How to Use
-
-<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
-
-## Main Types
-
-<!-- The main types provided in this library -->
-
-The main types provided by this library are:
-
-* ``
-* ``
-* ``
-
 ## Additional Documentation
 
 <!-- Links to further documentation -->
@@ -34,10 +12,6 @@ The main types provided by this library are:
 * [Safe storage of app secrets in development in ASP.NET Core](https://learn.microsoft.com/aspnet/core/security/app-secrets)
 * [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.usersecrets)
 
-## Related Packages
-
-<!-- The related packages associated with this package -->
-
 ## Feedback & Contributing
 
 <!-- How to provide feedback on this package and contribute to it -->
index 38560635038cb82d922772a69400f5f823cf6960..209645bc5a47324d0c4ac318bbfcd9a1de3d06cb 100644 (file)
@@ -4,14 +4,6 @@
 
 XML configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read configuration parameters from XML files. You can use [XmlConfigurationExtensions.AddXmlFile](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.xmlconfigurationextensions.addxmlfile) extension method on `IConfigurationBuilder` to add XML configuration provider to the configuration builder.
 
-## Key Features
-
-<!-- The key features of this package -->
-
-*
-*
-*
-
 ## How to Use
 
 <!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
@@ -71,16 +63,6 @@ You can include a configuration file using a code like this in your `.csproj` fi
 </ItemGroup>
 ```
 
-## Main Types
-
-<!-- The main types provided in this library -->
-
-The main types provided by this library are:
-
-* ``
-* ``
-* ``
-
 ## Additional Documentation
 
 <!-- Links to further documentation -->
@@ -88,10 +70,6 @@ The main types provided by this library are:
 * [XML configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#xml-configuration-provider)
 * [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.xml)
 
-## Related Packages
-
-<!-- The related packages associated with this package -->
-
 ## Feedback & Contributing
 
 <!-- How to provide feedback on this package and contribute to it -->
index d8bcd473f60d0a80c86149663253bbb05a36b385..19b13040a8aea98d72fa2437709688046c3ae340 100644 (file)
@@ -6,14 +6,6 @@ Provides abstractions for reading `.deps` files. When a .NET application is comp
 
 By default, the dependency manifest contains information about the application's target framework and runtime dependencies. Set the [PreserveCompilationContext](https://docs.microsoft.com/dotnet/core/project-sdk/msbuild-props#preservecompilationcontext) project property to `true` to additionally include information about reference assemblies used during compilation.
 
-## Key Features
-
-<!-- The key features of this package -->
-
-*
-*
-*
-
 ## How to Use
 
 <!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
@@ -42,16 +34,6 @@ class Program
 }
 ```
 
-## Main Types
-
-<!-- The main types provided in this library -->
-
-The main types provided by this library are:
-
-* ``
-* ``
-* ``
-
 ## Additional Documentation
 
 <!-- Links to further documentation -->
@@ -60,10 +42,6 @@ The main types provided by this library are:
 * [Microsoft.Extensions.DependencyModel namespace](https://docs.microsoft.com/dotnet/api/microsoft.extensions.dependencymodel)
 * [Microsoft.Extensions.DependencyModel.DependencyContext](https://docs.microsoft.com/dotnet/api/microsoft.extensions.dependencymodel.dependencycontext)
 
-## Related Packages
-
-<!-- The related packages associated with this package -->
-
 ## Feedback & Contributing
 
 <!-- How to provide feedback on this package and contribute to it -->
index a9cd4f5727700b149f5d30368193422a540929fe..836433b1a4bba54857981072f1c8a954e4def36c 100644 (file)
@@ -1,12 +1,21 @@
 ## About
+
+<!-- A description of the package and where one can find more documentation -->
+
 Contains the .NET Generic Host `HostBuilder` which layers on the `Microsoft.Extensions.Hosting.Abstractions` package.
 
 ## Key Features
+
+<!-- The key features of this package -->
+
 * Contains the .NET Generic Host `HostBuilder`.
 
 ## How to Use
+
+<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
+
 For a console app project:
-```cs
+```C#
     using (IHost host = new HostBuilder().Build())
     {
         var lifetime = host.Services.GetRequiredService<IHostApplicationLifetime>();
@@ -34,7 +43,11 @@ For a console app project:
 ```
 
 ## Main Types
+
+<!-- The main types provided in this library -->
+
 The main types provided by this library are:
+
 * `Microsoft.Extensions.Host`.
 * `Microsoft.Extensions.Hosting.HostApplicationBuilder`
 * `Microsoft.Extensions.Hosting.HostBuilder`
@@ -42,6 +55,9 @@ The main types provided by this library are:
 * `Microsoft.Extensions.Hosting.IHostedLifecycleService`
 
 ## Additional Documentation
+
+<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
+
 * [Generic host](https://learn.microsoft.com/dotnet/core/extensions/generic-host)
 * API documentation
   - [Host](https://learn.microsoft.com/dotnet/api/microsoft.extensions.hosting.host)
@@ -49,6 +65,9 @@ The main types provided by this library are:
   - [HostBuilder](https://learn.microsoft.com/dotnet/api/microsoft.extensions.hosting.hostbuilder)
 
 ## Related Packages
+
+<!-- The related packages associated with this package -->
+
 - `Microsoft.Extensions.Configuration`
 - `Microsoft.Extensions.DependencyInjection`
 - `Microsoft.Extensions.Hosting.Abstractions`
index b35f529af9c06c86c25e4f57b4ca55f49b1656b7..69823b6d4d3faa33c725cdc49c63c2113feadac3 100644 (file)
@@ -10,7 +10,6 @@
 * Allow logging to the console using the [Microsoft.Extensions.Logging](https://www.nuget.org/packages/Microsoft.Extensions.Logging/) package.
 * Provide extension methods for the [ILoggingBuilder](https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.iloggingbuilder) and [ILoggerProviderConfiguration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.configuration.iloggerproviderconfiguration-1) classes.
 
-
 ## How to Use
 
 <!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
index 1b39d42bb175f0d2dc13fc3406d618ff1e33aaad..563660c9be59ea94bbea327d5d437d31029cdbf4 100644 (file)
@@ -18,15 +18,49 @@ The `System.Collections.Immutable` library is built-in as part of the shared fra
 
 <!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
 
+```C#
+using System.Collections.Immutable;
+
+// Create immutable set of strings
+ImmutableHashSet<string> colors = ImmutableHashSet.Create("Red", "Green", "Blue");
+
+// Create a new set by adding and removing items from the original set
+ImmutableHashSet<string> colorsModified = colors.Remove("Red").Add("Orange");
+
+foreach (string s in colorsModified)
+{
+    Console.WriteLine(s);
+}
+
+/* Example output:
+ Blue
+ Green
+ Orange
+ */
+ ```
+
 ## Main Types
 
 <!-- The main types provided in this library -->
 
 The main types provided by this library are:
 
-* ``
-* ``
-* ``
+* `System.Collections.Immutable.ImmutableArray`
+* `System.Collections.Immutable.ImmutableArray<T>`
+* `System.Collections.Immutable.ImmutableDictionary`
+* `System.Collections.Immutable.ImmutableDictionary<TKey,TValue>`
+* `System.Collections.Immutable.ImmutableHashSet`
+* `System.Collections.Immutable.ImmutableHashSet<T>`
+* `System.Collections.Immutable.ImmutableList`
+* `System.Collections.Immutable.ImmutableList<T>`
+* `System.Collections.Immutable.ImmutableQueue`
+* `System.Collections.Immutable.ImmutableQueue<T>`
+* `System.Collections.Immutable.ImmutableSortedDictionary`
+* `System.Collections.Immutable.ImmutableSortedDictionary<TKey,TValue>`
+* `System.Collections.Immutable.ImmutableSortedSet`
+* `System.Collections.Immutable.ImmutableSortedSet<T>`
+* `System.Collections.Immutable.ImmutableStack`
+* `System.Collections.Immutable.ImmutableStack<T>`
 
 ## Additional Documentation
 
@@ -35,10 +69,6 @@ The main types provided by this library are:
 - [Collections and Data Structures](https://docs.microsoft.com/dotnet/standard/collections/)
 - [API documentation](https://docs.microsoft.com/dotnet/api/system.collections.immutable)
 
-## Related Packages
-
-<!-- The related packages associated with this package -->
-
 ## Feedback & Contributing
 
 <!-- How to provide feedback on this package and contribute to it -->
index fdaea06fddb7e3705d450dfc47b76b35057e8eb1..3a315884484cae598d1a1edaf94a2509643433db 100644 (file)
@@ -4,14 +4,6 @@
 
 Provides types that support using XML configuration files (`app.config`). This package exists only to support migrating existing .NET Framework code that already uses System.Configuration. When writing new code, use another configuration system instead, such as [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/).
 
-## Key Features
-
-<!-- The key features of this package -->
-
-*
-*
-*
-
 ## How to Use
 
 <!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
@@ -75,9 +67,8 @@ To run this example, include an `app.config` file with the following content in
 
 The main types provided by this library are:
 
-* ``
-* ``
-* ``
+* `System.Configuration.Configuration`
+* `System.Configuration.ConfigurationManager`
 
 ## Additional Documentation
 
index 42ee1764292807a0470764f4791b960e47aae5ca..df290dd1ab0f5086e8437c1afef7122517a5b6af 100644 (file)
@@ -6,14 +6,6 @@ This package provides a low-level .NET (ECMA-335) metadata reader and writer. It
 
 The `System.Reflection.Metadata` library is included in the .NET Runtime shared framework. The package can be installed when you need to use it in other target frameworks.
 
-## Key Features
-
-<!-- The key features of this package -->
-
-*
-*
-*
-
 ## How to Use
 
 <!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
index 1f0e974b2bab60dafc1903f509c559d976a908b9..f16805d7d3f14ac64f2d64a5c0a8d26835b06b79 100644 (file)
@@ -4,14 +4,6 @@
 
 Provides read-only reflection on assemblies in an isolated context with support for assemblies that target different processor architectures and runtimes. Using MetadataLoadContext enables you to inspect assemblies without loading them into the main execution context. Assemblies in MetadataLoadContext are treated only as metadata, that is, you can read information about their members, but cannot execute any code contained in them.
 
-## Key Features
-
-<!-- The key features of this package -->
-
-*
-*
-*
-
 ## How to Use
 
 <!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
@@ -51,9 +43,8 @@ class Program
 
 The main types provided by this library are:
 
-* ``
-* ``
-* ``
+* `System.Reflection.MetadataLoadContext`
+* `System.Reflection.MetadataAssemblyResolver`
 
 ## Additional Documentation
 
@@ -63,10 +54,6 @@ The main types provided by this library are:
 * [System.Reflection.MetadataLoadContext](https://docs.microsoft.com/dotnet/api/system.reflection.metadataloadcontext)
 * [System.Reflection.MetadataAssemblyResolver](https://docs.microsoft.com/dotnet/api/system.reflection.metadataassemblyresolver)
 
-## Related Packages
-
-<!-- The related packages associated with this package -->
-
 ## Feedback & Contributing
 
 <!-- How to provide feedback on this package and contribute to it -->
index 60abdb27032f1d93d67668347e4748e572ece3d9..5b79f3f7cfb01c413a3a5c781898e915b2e09f2d 100644 (file)
@@ -12,13 +12,9 @@ Packaged set of simple caching API's derived from those of the same namespace av
 
 <!-- The key features of this package -->
 
-*
-*
-*
-
-## How to Use
-
-<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
+* Use caching facilities like in ASP.NET, but without a dependency on the System.Web assembly.
+* Extensible caching mechanism
+* Possible to create custom caching providers
 
 ## Main Types