Skip to content
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

Adding OCaml-version in docs (header-/footer-line) #6739

Closed
vicuna opened this issue Dec 29, 2014 · 2 comments
Closed

Adding OCaml-version in docs (header-/footer-line) #6739

vicuna opened this issue Dec 29, 2014 · 2 comments

Comments

@vicuna
Copy link

vicuna commented Dec 29, 2014

Original bug ID: 6739
Reporter: oliver
Status: confirmed (set by @damiendoligez on 2015-01-05T18:04:38Z)
Resolution: open
Priority: normal
Severity: feature
Platform: ./.
OS: ./.
OS Version: ./.
Target version: later
Category: documentation

Bug description

Good helper for orientation in the documentation
would be, to have the ocaml-version being part of the documents
headline or footline.

So, if you have different versions of the documentation,
you can see, which one is the newer, to which OCaml-version it refers.

This makes much sense especially, if it's a printed document,
and here especially, if it's not the full documentation with titlepage,
but just some pages or an interesting chapter.

(Printing the full docs always can become expensive, so printing
just new parts, like for example, just Bytes-module, which was
one of the main changes following 4.00, would be nice.)

Having multiple printouts of the same chapter,
it then is not that obvious, which is the old and new version,
if it is not visible on every printed page.

This is not theoretically enhancement.
I reallylike to have printed refman.
And adding this information to the refman would be very helpful,
especially when doing partial printing of the docs....

Steps to reproduce

Look at the refman pages ;-)

@vicuna
Copy link
Author

vicuna commented Dec 2, 2015

Comment author: @alainfrisch

The manual text is now part of the main repository. Don't hesitate to propose concrete code.

@github-actions
Copy link

This issue has been open one year with no activity. Consequently, it is being marked with the "stale" label. What this means is that the issue will be automatically closed in 30 days unless more comments are added or the "stale" label is removed. Comments that provide new information on the issue are especially welcome: is it still reproducible? did it appear in other contexts? how critical is it? etc.

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

No branches or pull requests

1 participant