WordPress.org
Get WordPress

Making WordPress.org

Opened 6 years ago

Closed 6 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: seedsca's profile seedsca 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:

  1. Upload the plugin files to the /wp-content/plugins/plugin-name directory, or install the plugin through the WordPress plugins screen directly.
  2. Activate the plugin through the 'Plugins' screen in WordPress
  3. Use the Settings->Plugin Name screen to configure the plugin
  4. (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)

#1 @seedsca
6 years ago

  • Keywords has-patch removed

Couldn't find where the file is to make a patch for it...
Happy to do it otherwise.

#2 @Otto42
6 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 not incorrect, although it is possibly poorly explained.

Last edited 6 years ago by Otto42 (previous) (diff)

#3 @seedsca
6 years ago

  • Resolution set to invalid
  • Status changed from new to closed

Well that was embarrassing. Shoulda tested...

Thanks for the input.

Note: See TracTickets for help on using tickets.