cabal icon indicating copy to clipboard operation
cabal copied to clipboard

Organise cabal commands into subsections

Open ffaf1 opened this issue 1 year ago • 2 comments

Requested in #8309 , #8315


Please include the following checklist in your PR:

  • [x] Patches conform to the coding conventions.
  • [x] I don’t believe reordering warrants a changelog
  • [x] The documentation has been updated, if necessary.

Please also shortly describe how you tested your change. Bonus points for added tests!

ffaf1 avatar Jul 29 '22 19:07 ffaf1

Rendered here. I really dislike that you cannot explode more than one subsection at once (on the left menu).

ffaf1 avatar Jul 29 '22 19:07 ffaf1

Having a commit with --- to ^^^ would alas be non atomic (you get an error then you are “jumping” levels). You can do it one by one, introducing a section for each commit, but that would mean having out-of-sync documentation (half in the old style, half in the new style).

I am far from an expert with git, so suggestions are welcome. The diff is indeed a mess that even a rm / add would be cleaner.

ffaf1 avatar Aug 08 '22 18:08 ffaf1

This is — I think — as much as I can factour out while keeping commits atomic.

Alas, if you were to invoke something like git annotate or similar you will indeed hit this commit wall; I wouldn’t know how to sidestep this.

ffaf1 avatar Aug 18 '22 06:08 ffaf1

@ulysses4ever I wait for your feedback before putting a merge me label. If there is more I can do to make this granular I am ready to do it (or anything that facilitates you checking the history of the docs); if not, merge time it will be, as if this gets out of synch with master we are doubly screwed!

ffaf1 avatar Aug 18 '22 10:08 ffaf1

@ffaf1 looks good to me, thank you!

ulysses4ever avatar Aug 18 '22 11:08 ulysses4ever