aboutsummaryrefslogtreecommitdiff
path: root/doc/todo/include_msg_with_possible_reason_why_command___40__e.g._add__41___failed_into_--json_output/comment_3_2d41d67dcb6e700b1ecda3106e444a5e._comment
blob: d3872b23e7b38aa2d9f9114b105fa6b15eb94329 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
[[!comment format=mdwn
 username="joey"
 subject="""comment 3"""
 date="2018-02-16T16:50:27Z"
 content="""
A problem with this idea is that error messages are relatively uncommon,
and if they're hidden away in an extra field of an existing json message,
it would be easy for the consumer to forget to handle that uncommon case.

Note that git-annex currently doesn't document the actual json structure it
uses, which is more or less ok because any given git-annex subcommand will
always output the same json structure (except some note fields that
only sometimes appear, whose data is targeted at humans).
It's self-documenting. Using json for errors breaks that pattern.
"""]]