go-textile icon indicating copy to clipboard operation
go-textile copied to clipboard

Better docs/description for `textile subscription` command

Open doodlemania2 opened this issue 6 years ago • 8 comments
trafficstars

It is not clear from the docs, tour, and command line outputs that the subscription command ‘hangs’ while waiting for new output to print to the terminal. A more explicit mention of this in the docs/tour, plus a message printed to stdout might be useful?

doodlemania2 avatar May 28 '19 21:05 doodlemania2

Hi @doodlemania2 this is actually expected behavior. Essentially, subscribe is opening a streaming endpoint, and will output updates as they come. Generally it is most useful to call textile subscribe in a separate Terminal, and then run your various commands in your initial Terminal. The updates (say adding a file) should appear in your subscribe Terminal.

carsonfarmer avatar May 29 '19 00:05 carsonfarmer

We should probably clarify this in the tour docs 👍.

carsonfarmer avatar May 29 '19 00:05 carsonfarmer

Oh! Well, that actually makes perfect sense - yes, suggest clarify that and maybe also output something like: "subscription active, now listening...ctl-c to cancel" or something.

doodlemania2 avatar May 29 '19 01:05 doodlemania2

Good suggestions! I’m going to rename this ticket and use it to update the docs etc 👍

carsonfarmer avatar May 29 '19 04:05 carsonfarmer

Going with observe, will land soon.

balupton avatar Jun 11 '19 03:06 balupton

Ooops, that's not actually what I created this ticket for, its related to what sander linked for. We need a more clear explanation of what this command does in the tour and docs. Renaming is a separate issue, but the clearer usage is pretty important here I think.

carsonfarmer avatar Jun 11 '19 04:06 carsonfarmer

With that in mind, I think observe is a reasonable change.

carsonfarmer avatar Jun 11 '19 04:06 carsonfarmer

Ok, will re-open once the PR merge closes.

balupton avatar Jun 11 '19 04:06 balupton