Review/Create module documentation

ilo - June 19, 2009 - 15:15
Project:Login Security
Version:6.x-1.x-dev
Component:Documentation
Category:task
Priority:normal
Assigned:ilo
Status:closed
Description

The current documentation under the readme may not be clear enough. I'll write/complete it before getting the 1.0 out.

- Create a handbook page.
- Review the readme and reference the handbook where available.
- create advanced help files.

Before final publication I would like anyone natural english speaker make a quick review of it, as it's not my first laguange.

#1

ilo - June 23, 2009 - 11:20
Status:active» needs review

I've just modified the readme. My idea is to include this as handbook page. It would be great if someone could just view or review my english.

AttachmentSize
496448_documentation.patch 15.14 KB

#2

ilo - June 23, 2009 - 11:23

Forget the patch, I just uploaded the whole readme.txt file for the review.

AttachmentSize
README.txt 10.7 KB

#3

deekayen - June 23, 2009 - 14:46
Status:needs review» needs work
  • It's not necessary to comment the $Id$ tag in a txt file with PHP syntax
  • Drupal and PHP should be capitalized IMO
  • deniying => denying
  • "Login Security" is the capitalization on the project page, so "Login security" should match
  • add comma: "With Login security, a site administrator"
  • add colon: "two options:"
  • lowercase t: "Request Time delay:"
  • the "On", "when", "It's", and "on" have different cases after the colons in the list. choose one.
  • remove really, it's a less professional adjective: "It's really common"
  • happend => happened
  • multiple cases of "Maximun" => Maximum
  • lowercase t: "Any host Trying to guess"

#4

ilo - June 23, 2009 - 15:58
Status:needs work» needs review

Ok, I've fixed all of them. Thanks for the review deekayen. Should I commit or would you (or any one else) like to make another review? Included in this comment is the fixed txt version.

AttachmentSize
README.txt 10.53 KB

#5

deekayen - June 23, 2009 - 15:59
Status:needs review» reviewed & tested by the community

go ahead

#6

ilo - June 24, 2009 - 10:47
Status:reviewed & tested by the community» fixed

Commited to head and d6.x-1.x-dev

#7

System Message - July 8, 2009 - 10:50
Status:fixed» closed

Automatically closed -- issue fixed for 2 weeks with no activity.

 
 

Drupal is a registered trademark of Dries Buytaert.