DOCSP-29036: C guides reformatting #16
Annotations
10 errors and 2 warnings
TDBX Vale rules:
source/docs-libmongoc/guides/bulk.txt#L20
[vale] reported by reviewdog 🐶
[MongoDB.ConciseTerms] 'must' is preferred over 'need to'.
Raw Output:
{"message": "[MongoDB.ConciseTerms] 'must' is preferred over 'need to'.", "location": {"path": "source/docs-libmongoc/guides/bulk.txt", "range": {"start": {"line": 20, "column": 10}}}, "severity": "ERROR"}
|
TDBX Vale rules:
source/docs-libmongoc/guides/bulk.txt#L162
[vale] reported by reviewdog 🐶
[MongoDB.AvoidObscure] Use 'for example, such as' instead of 'e.g.'.
Raw Output:
{"message": "[MongoDB.AvoidObscure] Use 'for example, such as' instead of 'e.g.'.", "location": {"path": "source/docs-libmongoc/guides/bulk.txt", "range": {"start": {"line": 162, "column": 31}}}, "severity": "ERROR"}
|
TDBX Vale rules:
source/docs-libmongoc/guides/connection-pooling.txt#L14
[vale] reported by reviewdog 🐶
[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.
Raw Output:
{"message": "[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.", "location": {"path": "source/docs-libmongoc/guides/connection-pooling.txt", "range": {"start": {"line": 14, "column": 90}}}, "severity": "ERROR"}
|
TDBX Vale rules:
source/docs-libmongoc/guides/connection-pooling.txt#L39
[vale] reported by reviewdog 🐶
[MongoDB.Accessibility] Don't use language (such as 'normal') that defines people by their disability.
Raw Output:
{"message": "[MongoDB.Accessibility] Don't use language (such as 'normal') that defines people by their disability.", "location": {"path": "source/docs-libmongoc/guides/connection-pooling.txt", "range": {"start": {"line": 39, "column": 29}}}, "severity": "ERROR"}
|
TDBX Vale rules:
source/docs-libmongoc/guides/advanced-connections.txt#L46
[vale] reported by reviewdog 🐶
[MongoDB.NegativeWords] Use 'remove, delete' instead of the negative word 'destroy'.
Raw Output:
{"message": "[MongoDB.NegativeWords] Use 'remove, delete' instead of the negative word 'destroy'.", "location": {"path": "source/docs-libmongoc/guides/advanced-connections.txt", "range": {"start": {"line": 46, "column": 21}}}, "severity": "ERROR"}
|
TDBX Vale rules:
source/docs-libmongoc/guides/advanced-connections.txt#L64
[vale] reported by reviewdog 🐶
[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.
Raw Output:
{"message": "[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.", "location": {"path": "source/docs-libmongoc/guides/advanced-connections.txt", "range": {"start": {"line": 64, "column": 12}}}, "severity": "ERROR"}
|
TDBX Vale rules:
source/docs-libmongoc/guides/advanced-connections.txt#L92
[vale] reported by reviewdog 🐶
[MongoDB.NegativeWords] Use 'remove, delete' instead of the negative word 'destroy'.
Raw Output:
{"message": "[MongoDB.NegativeWords] Use 'remove, delete' instead of the negative word 'destroy'.", "location": {"path": "source/docs-libmongoc/guides/advanced-connections.txt", "range": {"start": {"line": 92, "column": 21}}}, "severity": "ERROR"}
|
TDBX Vale rules:
source/docs-libmongoc/guides/cursors.txt#L18
[vale] reported by reviewdog 🐶
[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.
Raw Output:
{"message": "[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.", "location": {"path": "source/docs-libmongoc/guides/cursors.txt", "range": {"start": {"line": 18, "column": 78}}}, "severity": "ERROR"}
|
TDBX Vale rules:
source/docs-libmongoc/guides/cursors.txt#L21
[vale] reported by reviewdog 🐶
[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.
Raw Output:
{"message": "[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.", "location": {"path": "source/docs-libmongoc/guides/cursors.txt", "range": {"start": {"line": 21, "column": 30}}}, "severity": "ERROR"}
|
TDBX Vale rules
reviewdog: Too many results (annotations) in diff.
You may miss some annotations due to GitHub limitation for annotation created by logging command.
Please check GitHub Actions log console to see all results.
Limitation:
- 10 warning annotations and 10 error annotations per step
- 50 annotations per job (sum of annotations from all the steps)
- 50 annotations per run (separate from the job annotations, these annotations aren't created by users)
Source: https://github.community/t5/GitHub-Actions/Maximum-number-of-annotations-that-can-be-created-using-GitHub/m-p/39085
|
TDBX Vale rules
Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: masesgroup/retrieve-changed-files@v2. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.
|
TDBX Vale rules
User-specified path (source/docs-libmongoc/authentication.txt,source/docs-libmongoc/guides/advanced-connections.txt,source/docs-libmongoc/guides/aggregate.txt,source/docs-libmongoc/guides/bulk.txt,source/docs-libmongoc/guides/client-side-field-level-encryption.txt,source/docs-libmongoc/guides/configuring_tls.txt,source/docs-libmongoc/guides/connection-pooling.txt,source/docs-libmongoc/guides/cursors.txt,source/docs-libmongoc/guides/distinct-mapreduce.txt,source/docs-libmongoc/guides/in-use-encryption.txt,source/docs-libmongoc/includes/examples/.gitignore,source/docs-libmongoc/includes/examples/aggregation/aggregation1.c,source/docs-libmongoc/includes/examples/basic_aggregation/basic-aggregation.c,source/docs-libmongoc/includes/examples/basic_aggregation/constants.c,source/docs-libmongoc/includes/examples/basic_aggregation/distinct.c,source/docs-libmongoc/includes/examples/basic_aggregation/map-reduce-advanced.c,source/docs-libmongoc/includes/examples/basic_aggregation/map-reduce-basic.c,source/docs-libmongoc/includes/examples/bulk/bulk-collation.c,source/docs-libmongoc/includes/examples/bulk/bulk1.c,source/docs-libmongoc/includes/examples/bulk/bulk2.c,source/docs-libmongoc/includes/examples/bulk/bulk3.c,source/docs-libmongoc/includes/examples/bulk/bulk4.c,source/docs-libmongoc/includes/examples/bulk/bulk5.c,source/docs-libmongoc/includes/examples/bulk/bulk6.c,source/docs-libmongoc/includes/examples/client-side-encryption-auto-decryption.c,source/docs-libmongoc/includes/examples/client-side-encryption-doc-snippets.c,source/docs-libmongoc/includes/examples/client-side-encryption-explicit.c,source/docs-libmongoc/includes/examples/client-side-encryption-helpers.c,source/docs-libmongoc/includes/examples/client-side-encryption-helpers.h,source/docs-libmongoc/includes/examples/client-side-encryption-schema-map.c,source/docs-libmongoc/includes/examples/client-side-encryption-server-schema.c,source/docs-libmongoc/includes/examples/cmake-deprecated/find_package/CMakeLists.txt,source/docs-libmongoc/includes/examples/cmake-deprecated/find_package_static/CMakeLists.txt,source/docs-libmongoc/includes/examples/cmake/find_package/CMakeLists.txt,source/docs-libmongoc/includes/examples/cmake/find_package_static/CMakeLists.txt,source/docs-libmongoc/includes/examples/cmake/vcpkg/CMakeLists.txt,source/docs-libmongoc/includes/examples/cmake/vcpkg/Makefile,source/docs-libmongoc/includes/examples/cmake/vcpkg/app.c,source/docs-libmongoc/includes/examples/common_operations/common-operations.c,source/docs-libmongoc/includes/examples/common_operations/explain.c,source/docs-libmongoc/includes/examples/compile-with-pkg-config-static.sh,source/docs-libmongoc/includes/examples/compile-with-pkg-config.sh,source/docs-libmongoc/includes/examples/doc-common-insert.c,source/docs-libmongoc/includes/examples/example-client.c,source/docs-libmongoc/includes/examples/example-collection-command.c,source/docs-libmongoc/includes/examples/example-collection-watch.c,source/docs-libmongoc/includes/examples/example-command-monitoring.c,source/docs-libmongoc/includes/examples/example-command-with-opts.c,source/docs-libmongoc/includes/examples/example-gridfs-bucket.c,source/docs-libmongoc/includes/examples/example-gridfs.c,source/docs-libmongoc/includes/examples/example-manage-collection-indexes.c,source/docs-libmongoc/includes/examples/example-manage-search-indexes.c,source/docs-libmongoc/includes/examples/example-pool.c,source/docs-libmongoc/includes/examples/example-resume.c,source/docs-libmongoc/includes/examples/example-scram.c,source/docs-libmongoc/includes/examples/example-sdam-monitoring.c,source/docs-libmongoc/includes/examples/example-session.c,source/docs-libmongoc/includes/examples/example-start-at-optime.c,source/docs-libmongoc/includes/examples/example-transaction.c,source/docs-libmongoc/includes/examples/example-update.c,source/docs-libmongoc/includes/examples/example-with-transaction-cb.c,source/docs-libmongoc/includes/examples/find-and-modify.c,source/docs-libmongoc/includes/examples/find_and_modify_with_opts/fam.c,source/docs-libmongoc/includes/examples
|