Skip to content

Take conditional compilation into account when generating documentation #857

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

Closed
yorickpeterse opened this issue Apr 4, 2025 · 2 comments
Assignees
Labels
bug Defects, unintended behaviour, etc compiler Changes related to the compiler
Milestone

Comments

@yorickpeterse
Copy link
Collaborator

Please describe the bug

Per https://github.com/inko-lang/inko/actions/runs/14242327365/job/39915164284 we're not taking into account conditional compilation tags when generating JSON documentation files, and instead just generate documentation for all modules. This results in CI failing because std.int.release implements types also implemented in std.int.debug.

Operating system

Arch Linux

Inko version

main

@yorickpeterse yorickpeterse added bug Defects, unintended behaviour, etc compiler Changes related to the compiler labels Apr 4, 2025
@yorickpeterse yorickpeterse added this to the 0.19.0 milestone Apr 4, 2025
@yorickpeterse yorickpeterse self-assigned this Apr 4, 2025
@yorickpeterse
Copy link
Collaborator Author

There's a bit of a problem with this approach: for libraries there's no clear "entry point", i.e. it could be src/foo.inko or src/whatever/bla.inko, such that the only option is to include all modules.

For the current failures I think what we can do is to keep the implementations in std.int but forward them to module methods defined in std.int.debug and std.int.release, similar to the std.sys setup used for other modules.

@yorickpeterse
Copy link
Collaborator Author

The CI failures are fixed by 0ece2dc, so because of that and the above comment I'll close this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Defects, unintended behaviour, etc compiler Changes related to the compiler
Projects
None yet
Development

No branches or pull requests

1 participant