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

Headache erases some lines #4

Open
Halbaroth opened this issue Apr 19, 2023 · 1 comment
Open

Headache erases some lines #4

Halbaroth opened this issue Apr 19, 2023 · 1 comment

Comments

@Halbaroth
Copy link

I used headache on my project but it seems to remove some lines. Let see a MRE:

The header:

  foo foo

The OCaml file:

(**************************************************************************)
(*    foo                                                                 *)
(**************************************************************************)
open Format

(* foo *)

The expected result with the command headache -h header.txt source.ml:

(**************************************************************************)
(*    foo foo                                                             *)
(**************************************************************************)
open Format

(* foo *)

The actual result:

(**************************************************************************)
(*    foo foo                                                             *)
(**************************************************************************)

(* foo *)
@maroneze
Copy link
Member

Thanks for the report. Indeed, I'm afraid this is a "known issue" in the code that we never had the time to look at, and since we only use headache in very specific cases, and we work around it, there is currently not much effort to direct at fixing it.

If you are interested and you believe you might fix it, we'd be glad to integrate it!

Otherwise, the least we could do is mention it directly in the README, just after the code example using -h:

WARNING: leave an empty line after the header, otherwise headache will erase it!

Do you think this would be clear enough?

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

No branches or pull requests

2 participants