coniks-sys / coniks-go

A CONIKS implementation in Golang
http://coniks.org
Other
116 stars 30 forks source link

Add doc for server's confs #143

Closed vqhuy closed 7 years ago

vqhuy commented 7 years ago
liamsi commented 7 years ago

LGTM

arlolra commented 7 years ago

I think it would be helpful to put some comments in the config.toml as well.

masomel commented 7 years ago

LGTM, too. I agree with @arlolra, comments in the config.toml would be helpful for someone who isn't familiar with toml files.

vqhuy commented 7 years ago

I just remembered that I have tried to encode comments to generated TOML files as well, but I haven't found any way, unfortunately.

liamsi commented 7 years ago

Not sure if this helps: https://github.com/BurntSushi/toml-test/blob/master/tests/valid/comments-everywhere.toml

vqhuy commented 7 years ago

Hmm, I think it is edited manually, not generated by toml.Encode.

masomel commented 7 years ago

Hmm, I think it is edited manually, not generated by toml.Encode.

I see. I'm fine not adding this (commented toml files) in for 0.1.0.

arlolra commented 7 years ago

The library doesn't have support for it yet in the encoder. See the open issues / pulls there.

I'm fine not adding this (commented toml files) in for 0.1.0

Yup, let's skip it for now.

vqhuy commented 7 years ago

Then should we merge this now (along with #145)?

arlolra commented 7 years ago

Then should we merge this now (along with #145)?

LGTM, but I'm losing faith in myself.