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

Jump to bottom

ocamldoc parsing error issues incorrect line number #7084

Closed
vicuna opened this issue Dec 11, 2015 · 3 comments
Closed

ocamldoc parsing error issues incorrect line number #7084

vicuna opened this issue Dec 11, 2015 · 3 comments
Labels
bug documentation Stale

Comments

@vicuna
Copy link

vicuna commented Dec 11, 2015 •
edited by damiendoligez

Original bug ID: 7084
Reporter: junsli
Status: acknowledged (set by @gasche on 2015-12-11T05:57:07Z)
Resolution: open
Priority: normal
Severity: minor
Version: 4.02.3
Category: documentation
Has duplicate: #7187
Related to: #5901

Bug description

Take this example in foo.ml

(** This comments should associate with function xxx
    @version 1
    @param x {!class1:my_class111}
    @param1 y {!class:my_class123}}
    *)
let xxx x y = x - y

It reports the following parsing error:

File "foo.ml", line 0, character 23:
y {!class:my_class123}}
                       ^
1 error(s) encountered

"line 0" is incorrect, as ocamldoc extracts each comment block (and inner element) out and parses them separately as strings, which causes the global location information missing.

(See also issue #5901, where the location info is not provided in the warning. The two bugs suffers from the same design issue, and probably shares the same solution)
This was referenced Mar 14, 2019
Closed
Closed
@vicuna vicuna added the bug label Mar 20, 2019
@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.

@github-actions github-actions bot added the Stale label May 11, 2020
@gasche gasche removed the Stale label May 11, 2020
@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.

@github-actions github-actions bot added the Stale label Oct 11, 2021
@gasche
Copy link
Member

gasche commented Oct 11, 2021

ocamldoc is being phased out to be replaced by odoc, and no one seems interested in fixing small interface bugs. Closing.

@gasche gasche closed this as completed Oct 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug documentation Stale
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gasche @vicuna