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

Clean removes generated docs #3353

Conversation

Matthew-Mosior
Copy link
Contributor

@Matthew-Mosior Matthew-Mosior commented Jul 25, 2024

This PR enables --clean to remove documentation generated via --mkdoc.

This addresses one of the tasks in #1918.

@Matthew-Mosior Matthew-Mosior changed the title Clean does not remove generated docs Clean removes generated docs Jul 25, 2024
let build = build_dir (dirs (options defs))
let docBase = build </> "docs"
let docDir = docBase </> "docs"
() <- do Right docfiles' <- coreLift $ listDir docDir
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Can we refactor the two do-blocks in their own auxiliary function?

Copy link
Contributor Author

@Matthew-Mosior Matthew-Mosior Jul 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! That sounds good, should be resolved via ccff608.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry that's not quite what I meant, the two functions you put in auxiliary definitions are essentially the same, except for the file path, it would be nice to remove this redundancy.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see! I think I've addressed this with d788e07.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why this test is failing ...

@Matthew-Mosior
Copy link
Contributor Author

@andrevidela I think this should be ready for you now :)

@andrevidela
Copy link
Collaborator

Looks good!

@andrevidela andrevidela merged commit d9049e8 into idris-lang:main Aug 5, 2024
22 checks passed
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

Successfully merging this pull request may close these issues.

2 participants