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

Driver: uniformize names for directories #1235

Merged
merged 1 commit into from
Nov 5, 2024

Conversation

panglesd
Copy link
Collaborator

@panglesd panglesd commented Nov 5, 2024

odoc_dir was sometimes used to refer to the root of the directory containing .odoc files (_odoc by default), and sometimes used to refer to the direct parent of a .odoc file.

The root of the directory containing .odoc files was referred as odoc_dir, output_dir.

The root of the directory containing .odocl files was referred as odocl_dir, link_dir, linked_dir.

This commit cleans that. The root of the directory for .odoc files is consistently named odoc_dir, the root for .odocl files is odocl_dir.

It has the nice effect of removing code with punning working, and fixing some misunderstanding wrt to this in the Landing_page module.

`odoc_dir` was sometimes used to refer to the root of the directory containing
.odoc files (`_odoc` by default), and sometimes used to refer to the direct
parent of a `.odoc` file.

The root of the directory containing `.odoc` files was referred as `odoc_dir`,
`output_dir`.

The root of the directory containing `.odocl` files was referred as `odocl_dir`,
`link_dir`, `linked_dir`.

This commit cleans that. The root of the directory for `.odoc` files is
consistently named `odoc_dir`, the root for `.odocl` files is
`odocl_dir`.
@panglesd panglesd added the no changelog This pull request does not need a changelog entry label Nov 5, 2024
@jonludlam
Copy link
Member

Much nicer, thanks!

@jonludlam jonludlam merged commit 3addbf9 into ocaml:master Nov 5, 2024
12 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no changelog This pull request does not need a changelog entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants