New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PR#7497: manual, numbered tables of contents #1095

Merged
merged 1 commit into from Mar 12, 2017

Conversation

Projects
None yet
2 participants
@Octachron
Contributor

Octachron commented Mar 10, 2017

MPR#7497:
This one-line PR enables numbered tables of contents in the splitted html version of OCaml manual.
The main motivation is numbered tables of contents make it easier to navigate the manual starting from section numbers. For instance, compare the amount of effort spent finding the section 7.23 (Generative functor) starting from the numbered manual compared to the current manual.

Another point, as noticed by @dbuenzli, is that some warnings refer to the (relatively new) manual section 8.5 for a in-depth explanation. Unfortunately, without a numbered main table of contents, it is not trivial to find this section 8.5 in the manual.

@gasche gasche merged commit e822d22 into ocaml:trunk Mar 12, 2017

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@gasche

This comment has been minimized.

Show comment
Hide comment
@gasche

gasche Mar 12, 2017

Member

Thanks! Merged.

Member

gasche commented Mar 12, 2017

Thanks! Merged.

@Octachron

This comment has been minimized.

Show comment
Hide comment
@Octachron

Octachron Mar 15, 2017

Contributor

I am thinking to cherry-pick this change to 4.05 since it is one-line usability improvement and it increases the uniformity of the different versions of the manual.

Any objections @damiendoligez, @gasche ?

Contributor

Octachron commented Mar 15, 2017

I am thinking to cherry-pick this change to 4.05 since it is one-line usability improvement and it increases the uniformity of the different versions of the manual.

Any objections @damiendoligez, @gasche ?

@gasche

This comment has been minimized.

Show comment
Hide comment
@gasche

gasche Mar 15, 2017

Member

None.

Member

gasche commented Mar 15, 2017

None.

@Octachron

This comment has been minimized.

Show comment
Hide comment
@Octachron

Octachron Mar 18, 2017

Contributor

As announced I have cherry-picked this to 4.05, and done some clean-up to trunk's changes file where sections were starting to bleed into each other.

Contributor

Octachron commented Mar 18, 2017

As announced I have cherry-picked this to 4.05, and done some clean-up to trunk's changes file where sections were starting to bleed into each other.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment