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

Duplicate object descriptions #416

Closed
CasperWA opened this issue Jan 4, 2023 · 2 comments
Closed

Duplicate object descriptions #416

CasperWA opened this issue Jan 4, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@CasperWA
Copy link
Collaborator

CasperWA commented Jan 4, 2023

Follow-up task from #415.

There are duplications in some methods or similar that are defined both in the C code and included Python files.
The resulting Sphinx warnings may also be due to overloaded functions, something that Sphinx and AutoAPI cannot handle.

@CasperWA CasperWA added the documentation Improvements or additions to documentation label Jan 4, 2023
@jesper-friis
Copy link
Collaborator

What methods are you referring to?

In general I think we want to use the same name in C and in the Python bindings for the same function (except that we in C prefix functions with dlite_).

@CasperWA
Copy link
Collaborator Author

CasperWA commented Jan 4, 2023

From building the Sphinx documentation:

.../dlite/pydoc/autoapi/dlite/dlite/index.rst:1444: WARNING: duplicate object description of dlite.dlite.Instance.save, other instance in autoapi/dlite/dlite/index, use :noindex: for one of them
.../dlite/pydoc/autoapi/dlite/dlite/index.rst:1700: WARNING: duplicate object description of dlite.dlite.get_instance, other instance in autoapi/dlite/dlite/index, use :noindex: for one of them
.../dlite/pydoc/autoapi/dlite/index.rst:1490: WARNING: duplicate object description of dlite.Instance.save, other instance in autoapi/dlite/index, use :noindex: for one of them

And I indeed found the get_instance() function defined in both a C file as well as an included Python file, which extends a C file, supposedly?
As I don't fully understand these relationships concerning building the package, I am unsure exactly how to be more specific.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants