Opened 8 years ago
Closed 8 years ago
#3759 closed defect (bug) (invalid)
readme.txt could be clearer by changing numbered ordered list from all 1.s to consecutive numbers
| Reported by: |
|
Owned by: | |
|---|---|---|---|
| Milestone: | Priority: | low | |
| Component: | Plugin Directory | Keywords: | |
| Cc: |
Description
Under the == Installation == section of the readme.txt example, the ordered list is a bunch of 1.s
It would be better as consecutive numbers since it depicts steps:
- Upload the plugin files to the
/wp-content/plugins/plugin-namedirectory, or install the plugin through the WordPress plugins screen directly. - Activate the plugin through the 'Plugins' screen in WordPress
- Use the Settings->Plugin Name screen to configure the plugin
- (Make your instructions match the desired user flow for activating and installing your plugin. Include any steps that might be needed for explanatory purposes)
Change History (3)
#2
@
8 years ago
That is showing that the ordered list methodology of markdown works.
The number 1 being there at the beginning of each line is correct, because in Markdown, the numbers you use for the list actually don't matter.
So, it's actually not incorrect, although it is possibly poorly explained.
Version 0, edited 8 years ago
by
(next)
Note: See
TracTickets for help on using
tickets.
Couldn't find where the file is to make a patch for it...
Happy to do it otherwise.