caderek / gramma

command-line grammar checker
https://caderek.github.io/gramma/
ISC License
251 stars 18 forks source link

The behavior of running the application without arguments is not described in the documentation #2

Closed DevSilv closed 5 years ago

DevSilv commented 5 years ago

After running the application without arguments, there appeared a blank line. The application seemed to not do anything. After pressing ENTER again, there appeared the following string in a new line:

No mistakes found!

After that, there appeared the command prompt, which may mean that the application terminates (I cannot be sure).

This behavior is not described in the documentation, and – for me – seems to be counterintuitive.

Actual behavior

The documentation has no description about what happening and/or what is going to happen when run in the console without arguments.

Expected behavior

The documentation contains the following information described:

caderek commented 5 years ago

Thanks, it is rather standard behavior - it works like cat and other *nix commands - it waits for input stream and then does its thing. But I should definitely clarify that.

caderek commented 5 years ago

@silvuss Let me know if this clarifies the docs: https://github.com/caderek/gramma/pull/3/commits/aba95ab987d0262c01f4ee95a7ae3e1b120272f8

caderek commented 5 years ago

Ok, closing - will reopen if needed.

DevSilv commented 5 years ago

@caderek Thanks, your fix (quick!) seems to be enough for this issue to me. :)