search

MarcWeber / vim-addon-manager

manage and install vim plugins (including their dependencies) in a sane way. If you have any trouble contact me. Usually I reply within 24 hours
Other
660 stars 59 forks source link

Subsection numbering clarifies we're in uninstall #37

Closed meonkeys closed 13 years ago

meonkeys commented 13 years ago

Hope this helps! -Adam

MarcWeber commented 13 years ago

Looks like we merged the previous commit too early :) merged

ZyX-I commented 13 years ago

It is illogical: these list items are not subsections, so there is no need to prepend 6.. Maybe it is better to delete blank lines between list items. And there is a similar list in installation section, but it does not have 2. before items.

meonkeys commented 13 years ago

Why are they not subsections?

Uninstalling is section "6", and these are uninstallation steps.

ZyX-I commented 13 years ago

Why are they not subsections?

Uninstalling is section "6", and these are uninstallation steps.

Have you ever seen steps being a subsections? I saw substeps (N. General description; N.1. Step 1; ...), but this is not the case.

Subsections

  1. extend a topic of their parent section;
  2. can be read on their own if you caught a general idea;
  3. contain enough text to be splitted from their parent section.

Neither of this is met:

  1. These steps do not extend the topic. They are the whole contents of it.
  2. Next step is useless unless you know previous step.
  3. These steps do not contain enough text.

Sometimes if you have 3. you can find out that it is possible to write text so that it will have 2. and 1., but you don't have 3. here.

meonkeys commented 13 years ago

Ah, cool. Thanks, that makes sense.

meonkeys commented 13 years ago

I don't have an example of using sub-section numbering for steps, maybe I'm wrong about that.

meonkeys commented 13 years ago

FFR: 6681cd35e69baa9a3831152ba09613eb551580cf reverts the numbering and replaces by a list. Win-win: no subsection numbering, still easy to read.