error-chain icon indicating copy to clipboard operation
error-chain copied to clipboard

not possible to document fields in struct type error in error block.

Open andete opened this issue 8 years ago • 6 comments

See errors.rs for an example. As far as I can see it is not possible to add documentation to the 3 fields of BridgeError.

It would be nice if that could be made possible in some way.

andete avatar Dec 17 '16 06:12 andete

@andete The link for the example doesn't work anymore, because the branch is gone.

LFalch avatar Dec 18 '16 01:12 LFalch

alternative location for errors.rs: https://github.com/Orangenosecom/philipshue/blob/master/src/errors.rs

andete avatar Dec 18 '16 04:12 andete

Or rather more permanent: https://github.com/Orangenosecom/philipshue/blob/431d1b166e8a07baac60ea31f6820fb200b0149e/src/errors.rs

andete avatar Dec 18 '16 04:12 andete

^^ Unfortunately, https://github.com/brson/error-chain/issues/63 makes it more complicated that it should. Do you want to try?

Yamakaky avatar Dec 18 '16 04:12 Yamakaky

No, I just noticed the issue wasn't reported yet. Even though it seems to be related to #63 , for a casual user of error-chain this may not be obvious.

andete avatar Dec 18 '16 05:12 andete

Yeah, I myself didn't notice it before your issue ^^

Yamakaky avatar Dec 18 '16 05:12 Yamakaky