docs: Update jq docs to show correct escaping

bazel-contrib / bazel-lib

Common useful functions for writing BUILD files and Starlark macros/rules

Apache License 2.0

140 stars 90 forks source link

docs: Update jq docs to show correct escaping #983

Open ChrisChinchilla opened 1 week ago

ChrisChinchilla commented 1 week ago

As seen here: https://github.com/bazel-contrib/bazel-lib/blob/31e6c76b7d2e91657913232ec33da6a8b6ace90b/lib/jq.bzl#L87

The docs show the incorrect escaping sequence.

alexeagle commented 5 days ago

Per the failing test, this needs to be updated in jq.bzl as well. Line 1 of the file you've edited is a hint that it's generated (would be nice if it said where it was generated from)

ChrisChinchilla commented 5 days ago

@alexeagle OK, this involved so much escaping to get them to show correctly in the generated MD, I now wonder if it makes the original file useful anymore? Also, can you check that espcaing is still indeed correct?