Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
ocamldoc: keep using relative instead of absolute source file names #986
The fact that ocamldoc uses absolute file paths in its error messages
raises the error message:
and then people jump to the reported error site from their editor, and
After the patch is applied, we get the following error message instead:
The code that is removed by the patch is also a mess, of undocumented
I am not imaginative enough to have a sense of what can go wrong as
Looking at ocamldoc code, I also have a hard time to see where things could go wrong. As far as I can see, file names are not really used outside of
Since relative paths are more human-readable, the only drawback that I can imagine would be external tools
I found the handling of file names in ocamldoc a bit confusing in general (and I suspect it can be improved; for example, I don't think that changing the file name using a lexer directive works in all the situations it should), but clarifying this would be a long-term change.
@Octachron thanks for the review. Do is mean that you think this is good to merge?