search

Test-More / test-more

Test2, Test::More, Test::Simple and Test::Builder Perl modules for writing tests
Other
140 stars 88 forks source link

Improve the TB2::History documentation #208

Closed schwern closed 10 years ago

schwern commented 12 years ago

The docs for History have become a mess.

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 commented 12 years ago

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

schwern commented 12 years ago

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 commented 12 years ago

How i can find this and other documents?

OmerFaruk04 commented 12 years ago

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

schwern commented 12 years ago

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 commented 12 years ago

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

OmerFaruk04 commented 12 years ago

What is your nickname?

schwern commented 12 years ago

I am cleverly disguised as "schwern".

OmerFaruk04 commented 12 years ago

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

OmerFaruk04 commented 12 years ago

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

schwern commented 12 years ago

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.