-
-
Notifications
You must be signed in to change notification settings - Fork 456
Closed
Labels
Description
It seems like tox
has cogapp
integrated in a way that it does not give a contributor action items to follow. It just prints out Check failed
and unless one digs deep to understand the connection between RST->tox->cog->cog syntax->standalone program install, it might be difficult for a newbie to proceed with reacting to the failure.
It's not mentioned anywhere in the contributing doc (#2051). The tox-integrated commands always have --check
with no integration for the caller to replace it with other args.
I imagine the command to document would be
$ tox exec -q -e doc -- python -m cogapp -cr 'doc/*.rst'`
But in general, I think the entire expected workflow should be documented somehow.
Another possibility would be implementing nedbat/cog#21 and moving it there in a normal formatting mode.