PR#7478: ocamldoc, avoid module preamble repetition #1037
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Octachron
force-pushed
the
ocamldoc_preamble_duplication
branch
from
6302f5b
to
754813c
Compare
Octachron
changed the title
dra27
reviewed
Feb 18, 2017
Changes
Outdated
| - PR#7478, GPR#1037: ocamldoc, do not use as a module preamble documentation | ||
| comments that occur after the first module element | ||
| (Florian Angeletti, report by Daniel Bünzli) | ||
|
|
There was a problem hiding this comment.
Doesn't this qualify as a breaking change (even if a good one)?
There was a problem hiding this comment.
It does not seem completely clear-cut to me since documentations affected by the change were already somehow broken. Nevertheless, erring on the side of caution and adding a warning about open statements is probably better.
dra27
reviewed
Feb 18, 2017
ocamldoc/odoc_sig.ml
Outdated
| | a :: _ when a.Parsetree.psig_loc.Location.loc_start.Lexing.pos_cnum < | ||
| fst info -> | ||
| (0,None) | ||
| | _ -> info in |
There was a problem hiding this comment.
Is it possible to refactor this to remove the small code duplication with odoc_ast.ml?
There was a problem hiding this comment.
Possible, certainly. Optimal, I am not so sure, see d7269c0 .
To avoid module preamble repetition, ocamldoc only use as a module preamble documentation comments that occur before any module elements, which should also prevent some unexpected module preamble when the first documentation comments appears in the middle of the source file.
Octachron
force-pushed
the
ocamldoc_preamble_duplication
branch
from
92ff0fc
to
64d9cee
Compare
Octachron
force-pushed
the
ocamldoc_preamble_duplication
branch
from
64d9cee
to
3bf7f9f
Compare
dra27
approved these changes
Aug 9, 2017
|
Nice work, thanks! |
stedolan
pushed a commit
to stedolan/ocaml
that referenced
this pull request
Mar 21, 2023
stedolan
pushed a commit
to stedolan/ocaml
that referenced
this pull request
Mar 21, 2023
Revert "Use Import_info.t in Cmt_format (ocaml#1037)" This reverts commit 2798499.
EmileTrotignon
pushed a commit
to EmileTrotignon/ocaml
that referenced
this pull request
Jan 12, 2024
Co-authored-by: Cuihtlauac ALVARADO <cuihtmlauac@tarides.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MPR#7478:
Currently, ocamldoc uses the first documentation comment in a source file as a module preamble. This has the unfortunate consequence that ocamldoc can use documentation comments far from the start of the file as a preamble. Moreover, if this first documentation comment occurs after any module element, this documentation comment will appear twice in the generated documentation: first as a module preamble, then at its original position in the source file:
This PR proposes to fix this duplication of documentation comments by using as module preamble, only documentation comments that appear before any module elements: