Skip to content

Commit b4a2b45

Browse files
committed
Doc improvements
1 parent b313db5 commit b4a2b45

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

src/SeqCli/Config/RuntimeConfigurationLoader.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ static class RuntimeConfigurationLoader
1111
const string DefaultEnvironmentVariablePrefix = "SEQCLI_";
1212

1313
/// <summary>
14-
/// This is the method to use when loading configuration for runtime use. It will apply overrides from the
15-
/// secret store and environment, and validate the configuration.
14+
/// This is the method to use when loading configuration for runtime use. It will read the default configuration
15+
/// file, if any, and apply overrides from the environment.
1616
/// </summary>
1717
public static SeqCliConfig Load()
1818
{

src/SeqCli/Config/SeqCliConfig.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ class SeqCliConfig
3535
}
3636
};
3737

38+
/// <summary>
39+
/// Loads <paramref name="filename"/> without considering any environment overrides, nor performing any validation.
40+
/// This method is typically used when editing/manipulating the configuration file itself. To read and use the
41+
/// configuration at runtime, see <see cref="RuntimeConfigurationLoader.Load"/>.
42+
/// </summary>
3843
public static SeqCliConfig ReadFromFile(string filename)
3944
{
4045
var content = File.ReadAllText(filename);

0 commit comments

Comments
 (0)