Improve the TB2::History documentation #208

Closed
schwern opened this Issue Nov 15, 2011 · 11 comments

Projects

None yet

2 participants

@schwern
Member
schwern commented Nov 15, 2011

The docs for History have become a mess.

  • Come up with sensible categories. "statistics" in particular is no longer relevant.
  • Document undocumented methods

The documentation is embedded in lib/TB2/History.pm. Tests for History are in t/History/ and can shed some light on what the methods do. Please ask if you're not sure about anything.

@OmerFaruk04

Hi I'm a google code-in contester and i want to take this task

@schwern
Member
schwern commented Dec 1, 2011

Great! Claim one of the "solve a documentation problem in Test::More" tasks like http://www.google-melange.com/gci/task/view/google/gci2011/7122324 and note this issue URL in the ticket.

This is going to need to be a lot of back and forth as you work out what things in History do and I help correct. I highly encourage you to follow the https://github.com/schwern/test-more/wiki/Preferred-workflow If you commit changes in your branch and issue the pull request early, I can see what you're doing and comment easier.

Have you written Perl documentation before?

@OmerFaruk04

How i can find this and other documents?

@OmerFaruk04

I haven't written any Perl documentation but i have written any kind of documentation

@schwern
Member
schwern commented Dec 1, 2011

Sorry, I'm not sure what "this and other documents" refers to. Could you clarify?

Perl documentation is written in POD. It's very simple. Mostly you can crib from the surrounding documentation. You read the documentation by running a file through the "perldoc" command.

@schwern
Member
schwern commented Dec 1, 2011

PS If you come onto the irc.perl.org IRC server channel #GCI we can talk.

@OmerFaruk04

What is your nickname?

@schwern
Member
schwern commented Dec 1, 2011

I am cleverly disguised as "schwern".

@OmerFaruk04

Colud you give this link to me?
Icouldn't find it.

@OmerFaruk04

I couldn't find irc.perl.org IRC server channel #GCI

@schwern
Member
schwern commented Dec 1, 2011

Sorry, link to what?

IRC is Internet Relay Chat. It's like IM before there was IM, but far more powerful. You need to get an IRC client and connect to the irc.perl.org server with it, then join the channel #gci. Then we can have this conversation with lots of other people participating to help. There's a rather old tutorial here: http://www.irchelp.org/irchelp/irctutorial.html XChat and mIRC are decent clients.

@schwern schwern closed this Mar 16, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment