[couchdb] branch docs/replace-dollar-sign created (now 21c52225c)

[ro...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ronny pushed a change to branch docs/replace-dollar-sign
in repository https://gitbox.apache.org/repos/asf/couchdb.git


      at 21c52225c Unifying the notation of dynamic parameters in the docs 2

This branch includes the following new commits:

     new 21c52225c Unifying the notation of dynamic parameters in the docs 2

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.

[couchdb] 01/01: Unifying the notation of dynamic parameters in the docs 2

[ro...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ronny pushed a commit to branch docs/replace-dollar-sign
in repository https://gitbox.apache.org/repos/asf/couchdb.git

commit 21c52225c36e6e0dc298c2342c4a44be87fe5461
Author: Ronny Berndt <ro...@apache.org>
AuthorDate: Thu Feb 23 15:02:20 2023 +0100

    Unifying the notation of dynamic parameters in the docs 2
    
    The pattern {var} has been established to clarify dynamic parameters in the documentation.
    Standardization and clarification of some not yet converted notation of parameters.
---
 src/docs/src/api/server/authn.rst  | 2 +-
 src/docs/src/cluster/purging.rst   | 2 +-
 src/docs/src/config/replicator.rst | 4 ++--
 3 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/docs/src/api/server/authn.rst b/src/docs/src/api/server/authn.rst
index 41f77e176..7744d12fd 100644
--- a/src/docs/src/api/server/authn.rst
+++ b/src/docs/src/api/server/authn.rst
@@ -457,7 +457,7 @@ surrounded by at least one space on each side. This might be useful in the
 character.
 
 JWT tokens that do not include a ``kid`` claim will be validated against the
-``$alg:_default`` key.
+``{alg}:_default`` key.
 
 It is mandatory to specify the algorithm associated with every key for security
 reasons (notably presenting a HMAC-signed token using an RSA or EC public key
diff --git a/src/docs/src/cluster/purging.rst b/src/docs/src/cluster/purging.rst
index d0704edb7..2d8f00ed5 100644
--- a/src/docs/src/cluster/purging.rst
+++ b/src/docs/src/cluster/purging.rst
@@ -65,7 +65,7 @@ Local Purge Checkpoint Documents
 ====================================
 Indexes and internal replications of the database with purges create and
 periodically update local checkpoint purge documents:
-``_local/purge-$type-$hash``. These documents report the last ``purge_seq``
+``_local/purge-{type}-{hash}``. These documents report the last ``purge_seq``
 processed by them and the timestamp of the last processing. An example of a
 local checkpoint purge document:
 
diff --git a/src/docs/src/config/replicator.rst b/src/docs/src/config/replicator.rst
index 63caca88e..dc89ecca3 100644
--- a/src/docs/src/config/replicator.rst
+++ b/src/docs/src/config/replicator.rst
@@ -329,7 +329,7 @@ Fair Share Replicator Share Allocation
 
 .. config:section:: replicator.shares :: Per-Database Fair Share Allocation
 
-    .. config:option:: $replicator_db :: Value for a replicator database
+    .. config:option:: {replicator_db} :: Value for a replicator database
 
         .. versionadded:: 3.2.0
 
@@ -338,7 +338,7 @@ Fair Share Replicator Share Allocation
         value is 100, minimum is 1 and maximum is 1000. The
         configuration may be set even if the database does not exist.
 
-        In this context the option ``$replicator_db`` acts as a placeholder
+        In this context the option ``{replicator_db}`` acts as a placeholder
         for your replicator database name. The default replicator database is
         ``_replicator``. Additional replicator databases can be created. To be
         recognized as such by the system, their database names should end with