search

Test-More / TB2

Test::Builder version 2, the next generation of building testing modules in Perl
Other
1 stars 0 forks source link

Improve the TB2::History documentation #36

Open schwernbot opened 10 years ago

schwernbot commented 10 years ago

From: @schwern Date: Tuesday Nov 15, 2011 at 08:26 GMT Orig: https://github.com/Test-More/test-more/issues/208

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.

schwernbot commented 10 years ago

From: @OmerFaruk04 Date: Thursday Dec 01, 2011 at 11:38 GMT Orig: https://github.com/Test-More/test-more/issues/208#issuecomment-2973743

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

schwernbot commented 10 years ago

From: @schwern Date: Thursday Dec 01, 2011 at 19:37 GMT Orig: https://github.com/Test-More/test-more/issues/208#issuecomment-2979389

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?

schwernbot commented 10 years ago

From: @OmerFaruk04 Date: Thursday Dec 01, 2011 at 19:46 GMT Orig: https://github.com/Test-More/test-more/issues/208#issuecomment-2979535

How i can find this and other documents?

schwernbot commented 10 years ago

From: @OmerFaruk04 Date: Thursday Dec 01, 2011 at 19:49 GMT Orig: https://github.com/Test-More/test-more/issues/208#issuecomment-2979565

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

schwernbot commented 10 years ago

From: @schwern Date: Thursday Dec 01, 2011 at 19:59 GMT Orig: https://github.com/Test-More/test-more/issues/208#issuecomment-2979706

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.

schwernbot commented 10 years ago

From: @schwern Date: Thursday Dec 01, 2011 at 20:01 GMT Orig: https://github.com/Test-More/test-more/issues/208#issuecomment-2979737

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

schwernbot commented 10 years ago

From: @OmerFaruk04 Date: Thursday Dec 01, 2011 at 20:07 GMT Orig: https://github.com/Test-More/test-more/issues/208#issuecomment-2979814

What is your nickname?

schwernbot commented 10 years ago

From: @schwern Date: Thursday Dec 01, 2011 at 20:11 GMT Orig: https://github.com/Test-More/test-more/issues/208#issuecomment-2979869

I am cleverly disguised as "schwern".

schwernbot commented 10 years ago

From: @OmerFaruk04 Date: Thursday Dec 01, 2011 at 20:14 GMT Orig: https://github.com/Test-More/test-more/issues/208#issuecomment-2979903

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

schwernbot commented 10 years ago

From: @OmerFaruk04 Date: Thursday Dec 01, 2011 at 20:26 GMT Orig: https://github.com/Test-More/test-more/issues/208#issuecomment-2980082

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

schwernbot commented 10 years ago

From: @schwern Date: Thursday Dec 01, 2011 at 20:51 GMT Orig: https://github.com/Test-More/test-more/issues/208#issuecomment-2980414

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.