mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

comment

Browse source
This commit is contained in:
Joey Hess 2018-02-16 13:28:13 -04:00
parent 7e454ee341
commit 1758982760
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
doc/todo/include_msg_with_possible_reason_why_command___40__e.g._add__41___failed_into_--json_output/comment_3_2d41d67dcb6e700b1ecda3106e444a5e._comment Normal file
View file

@ -0,0 +1,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.
"""]]