Last modified: 2011-08-31 08:03:56 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T30958, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 28958 - Help button/add documentation
Help button/add documentation
Status: RESOLVED WONTFIX
Product: MediaWiki extensions
Classification: Unclassified
Translate (Other open bugs)
unspecified
All All
: High normal (vote)
: ---
Assigned To: Niklas Laxström
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2011-05-13 15:01 UTC by Mark A. Hershberger
Modified: 2011-08-31 08:03 UTC (History)
1 user (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description Mark A. Hershberger 2011-05-13 15:01:07 UTC
It would be good to have an "add documentation" button in addition to the "Help" button that would automatically generate a FIXME in code review for the message where this is needed.  Sometimes this should be automatic even... messages with arguments often need this.
Comment 1 Niklas Laxström 2011-05-13 15:51:50 UTC
You mean "request documentation"? How would you automatically identify in which revision messages are added? How to extend that to all projects we support?
Comment 2 Mark A. Hershberger 2011-05-13 16:45:35 UTC
(In reply to comment #1)
> You mean "request documentation"? How would you automatically identify in which
> revision messages are added? How to extend that to all projects we support?

svn annotate will easily find the last revision to touch a line of code.  IIRC, git annotate does the same thing.

For non-mw software, maybe have a way that such software could provide an email destination, then send them an email with the committee name and and revision number that the change was made in.

Probably a way to put in a URL that Translate could trigger would work for both MW software and other software.
Comment 3 Niklas Laxström 2011-05-13 21:17:51 UTC
SVN annotate is slow. On the other hand it is pretty easy to find the i18n file where the message comes from.
Comment 4 Niklas Laxström 2011-05-14 08:12:03 UTC
Little more: how to know on which line(s) of the file given message key is?
Comment 5 Mark A. Hershberger 2011-05-14 16:43:39 UTC
(In reply to comment #4)
> Little more: how to know on which line(s) of the file given message key is?

"grep -n file" works for me ;)

Alternatively use file_get_contents() and count the newlines before the message you're searching for.

Or, use token_get_all()
Comment 6 Niklas Laxström 2011-05-14 17:06:21 UTC
Think about some key named "off" or "no". Grep will match about anything.
Comment 7 Mark A. Hershberger 2011-05-15 01:26:39 UTC
(In reply to comment #6)
> Think about some key named "off" or "no". Grep will match about anything.

Sure.  And the author should not provide such stupid keys.

But in any case, the line number isn't strictly necessary, is it?  If you find multiple matches, don't give them a line number, just the message key.
Comment 8 Niklas Laxström 2011-07-11 11:26:47 UTC
I'm still not convinced about this. Poking the developers manually seems easy enough as long as someone does it.
Comment 9 Niklas Laxström 2011-08-31 08:03:56 UTC
Marking WONTFIX unless someone comes up with a great idea how to do this.

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links