https://bugzilla.wikimedia.org/show_bug.cgi?id=25630

--- Comment #3 from Bawolff <bawolff...@gmail.com> 2010-10-23 21:13:11 UTC ---
(In reply to comment #2)
> First, there should be a comment in the file saying 'for instructions use
> $ php edit.php --help'

That's pretty standard, I think we can presume that people have a basic
knowledge of the unix convention that commandName --help gives them help.
Failing that they can look at mediawiki wiki where this is also documented.
Furthermore just running it without any arguments will also give the help
message.


> 
> Then the should be an example of how one could use it to say add a line
> at the third line of a file:
> 
> wget http://en.wikipedia.org/wiki/Food?action=raw -O Food
> ed Food <<EOF
> 3i
> bla bla
> .
> w
> q
> EOF
> php edit.php Food < Food
> 
> Wait, what do I see in getText.php!:
> 
>  * Outputs page text to stdout, useful for command-line editing automation.
>  * Example: php getText.php "page title" | sed -e '...' | php edit.php "page
> title"
> 
> Well, if only that example also was there in the edit.php usage message...

Perhaps an example would be useful (I added one to
http://www.mediawiki.org/wiki/Manual:Edit.php ) on the other hand its not
really the job of these help messages to teach basic unix concepts. A person
using one of these scripts should (hopefully) know what edit the article given
as the last argument with the text from stdin means (but thats just imho).

-- 
Configure bugmail: https://bugzilla.wikimedia.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.
You are on the CC list for the bug.

_______________________________________________
Wikibugs-l mailing list
Wikibugs-l@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikibugs-l

Reply via email to