Improve documentation of SinkSH
ClosedPublic
Actions

Authored by rnicole on Aug 2 2018, 8:49 AM.

Details

Reviewers

cmollekopf

Commits

R9:50bed81038f1: Improve documentation of SinkSH

Summary

TODO:

~~Better document the --reduce option in the list command~~
Get the parent command for sub-commands so we could show help for trace on and not just on
Pass the syntax to the implementation of the command so commands can easily show help on wrong usage. Also, SyntaxTree could do automatic input validation in the future, this could also help.
Even with the new documentation, some command could still be confusing. Should we add some usage examples?

Repository

R9 Sink

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

rnicole requested review of this revision.Aug 2 2018, 8:49 AM

rnicole created this revision.

Better explanation of the --reduce option in the list command

Looks great =)

sinksh/syntax_modules/sink_trace.cpp
39	Why not have the syntax() last and avoid the extra declarations?

sinksh/syntax_modules/sink_trace.cpp
39	It's for when reading the code, I find it much nicer to have a good summary of what it does at the top (and it can help newcomers too)

sinksh/syntax_modules/sink_trace.cpp
39	That's not the coding style anywhere else in the code though. It's IMO also a much more established practice in C code to have the main() (or equivalent) function at the bottom, and everything that get's called from it above. Please adjust the code accordingly (REGISTER_SYNTAX at the very bottom, syntax() right above it).

Put syntax and REGISTER_SYNTAX at the bottom

Excellent, thanks =)

This revision is now accepted and ready to land.Aug 3 2018, 8:10 AM

This revision was automatically updated to reflect the committed changes.

			Path	Packages
M			sinksh/syntax_modules/core_syntax.cpp (14 lines)
M			sinksh/syntax_modules/sink_clear.cpp (7 lines)
M			sinksh/syntax_modules/sink_count.cpp (10 lines)
M			sinksh/syntax_modules/sink_create.cpp (35 lines)
M			sinksh/syntax_modules/sink_drop.cpp (6 lines)
M			sinksh/syntax_modules/sink_inspect.cpp (22 lines)
M			sinksh/syntax_modules/sink_list.cpp (18 lines)
M			sinksh/syntax_modules/sink_livequery.cpp (15 lines)
M			sinksh/syntax_modules/sink_modify.cpp (27 lines)
M			sinksh/syntax_modules/sink_remove.cpp (28 lines)
M			sinksh/syntax_modules/sink_stat.cpp (11 lines)
M			sinksh/syntax_modules/sink_sync.cpp (5 lines)
M			sinksh/syntax_modules/sink_trace.cpp (7 lines)
M			sinksh/syntaxtree.h (23 lines)
M			sinksh/syntaxtree.cpp (98 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	38931			Aug 2 2018, 8:41 AM	★	★
Diff 2	38935			Aug 2 2018, 9:49 AM	★	★
Diff 3	38940			Aug 2 2018, 12:09 PM	★	★
Diff 4	39021	ad3dc22	R9:50bed81038f10091d35c5719df8078612393ae95	Aug 3 2018, 3:10 PM	★	★