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

[Docs] Possible outdated documentation #52

Closed
1 task
wesleytanws opened this issue Dec 6, 2021 · 3 comments
Closed
1 task

[Docs] Possible outdated documentation #52

wesleytanws opened this issue Dec 6, 2021 · 3 comments
Assignees

Comments

@wesleytanws
Copy link

We have identified 1 possible instance of outdated documentation:

About

This is part of a research project that aims to automatically detect outdated documentation in GitHub repositories. We are evaluating the validity of our approach by identifying instances of outdated documentation in real-world projects.

We hope that this research will be a step towards keeping documentation up-to-date. If this has been helpful, consider updating the documentation to keep it in sync with the source code. If this has not been helpful, consider updating this issue with an explanation, so that we can improve our approach. Thanks!

@rwgk
Copy link
Collaborator

rwgk commented Dec 6, 2021

Hi @akekawit, is this just a simple oversight?

@akekawit
Copy link
Collaborator

akekawit commented Dec 6, 2021

I removed DPYTHON_INCLUDE_DIR from the workflow since we were using default Python installation so cmake is able to configure the include directory automatically. For users who are using virtual environments or have multiple versions of Python installed, they will still need to pass the DPYTHON_INCLUDE_DIR flag.

This is one of the standard cmake flags, so there are no references to this flag left in the codebase. That's most likely why it's been flagged.

@rwgk
Copy link
Collaborator

rwgk commented Dec 6, 2021

Thanks Akekawit!

@rwgk rwgk closed this as completed Dec 6, 2021
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

3 participants