From 71712183ac69f9049b54f72b3640bbcfc87d551c Mon Sep 17 00:00:00 2001 From: schou Date: Mon, 22 Feb 2021 02:39:03 -0500 Subject: [PATCH] minor wording updates Signed-off-by: schou --- docs/disabled_features.md | 23 ++++++++++++++++------- docs/querying/basics.md | 9 ++++----- 2 files changed, 20 insertions(+), 12 deletions(-) diff --git a/docs/disabled_features.md b/docs/disabled_features.md index 02befe9343..2ceb53f635 100644 --- a/docs/disabled_features.md +++ b/docs/disabled_features.md @@ -5,24 +5,33 @@ sort_rank: 10 # Disabled Features -Here is a list of features that are disabled by default since they are breaking changes or are considered experimental. -Their behaviour can change in future releases which will be communicated via the [release changelog](https://github.com/prometheus/prometheus/blob/master/CHANGELOG.md). +These features are disabled by default since they are breaking changes or are +considered experimental. As their behavior may change in future releases, +all feature changes are communicated via the [release +changelog](https://github.com/prometheus/prometheus/blob/master/CHANGELOG.md). -You can enable them using the `--enable-feature` flag with a comma separated list of features. -They may be enabled by default in future versions. +One can enable one or more features using the `--enable-feature` flag with a +single feature or a comma-separated list of features. In future releases, +features may be enabled by default. ## `@` Modifier in PromQL `--enable-feature=promql-at-modifier` -The `@` modifier lets you specify the evaluation time for instant vector selectors, -range vector selectors, and subqueries. More details can be found [here](querying/basics.md#modifier). +The `@` modifier lets one specify the evaluation time for instant vector +selectors, range vector selectors, and subqueries. More details can be found +[here](querying/basics.md#-modifier). ## Negative offset in PromQL `--enable-feature=promql-negative-offset` -In contrast to the positive offset modifier, the negative offset modifier lets one shift a vector into the past. An example in which one may want to use a negative offset is: when reviewing past data and making temporal comparisons with more recent data. More details can be found [here](querying/basics.md#offset-modifier). +In contrast to the positive offset modifier, the negative offset modifier lets +one shift a vector into the past. An example in which one may want to use a +negative offset is reviewing past data and making temporal comparisons with +more recent data. + +More details can be found [here](querying/basics.md#offset-modifier). ## Remote Write Receiver diff --git a/docs/querying/basics.md b/docs/querying/basics.md index 90287b9983..c0ad947fb3 100644 --- a/docs/querying/basics.md +++ b/docs/querying/basics.md @@ -209,11 +209,10 @@ can be specified: rate(http_requests_total[5m] offset -1w) -This negative offset is disabled by default since it breaks the invariant -that PromQL does not look ahead of the evaluation time for samples. This -feature is enabled by setting `--enable-feature=promql-negative-offset` -flag. See [disabled features](../disabled_features.md) for more details -about this flag. +This negative offset has been disabled by default since it breaks the invariant +that PromQL does not look ahead of the evaluation time for samples. This feature +is enabled by setting `--enable-feature=promql-negative-offset` flag. See +[disabled features](../disabled_features.md) for more details about this flag. ### @ modifier