Comments (4)
happy to provide a PR, if you agree that this is wrong/misleading.
from simpleitk.
Thank you for the report.
It looks like the C++ move constructor is what python picked up for the doc strings.
This is the file where SWIG picks up the doc strings:
https://github.com/SimpleITK/SimpleITK/blob/9db174c691899d0eb608edfeb649d50c215e7a25/Wrapping/Python/PythonDocstrings.i#L16417-L16441
That file is generated by manually running a script to convert the C++ Doxygen into the doc strings:
https://github.com/SimpleITK/SimpleITK/blob/master/Utilities/GenerateDocs/SwigDocUpdate.sh
This particular methods is not even seen by SWIG, but is enabled when the Doxygen is run. Maybe a separate doxygen run could be done with SWIG defined? Maybe one of those scripts could be updated which generate the .i
file.
Honestly, this doctoring system is a little clunky. SWIG added some support for Doxygen strings, which would be easier, but last I looked at the output it appears inferior to what was currently being produced. It may deserve another look.
from simpleitk.
If I understand correctly, the .i
files are generated manually? Do you run it after each PR if the API changes or what triggers the update?
I think the simplest and cleanest way would be to define SWIG
when generating the .xml files during the build. Then these methods probably would not get picked up by doxygen.
from simpleitk.
Actually, I think the easiest thing to do would to just ignore this method here:
https://github.com/SimpleITK/SimpleITK/blob/master/Wrapping/Python/Python.i#L33
from simpleitk.
Related Issues (20)
- Clarify Windows build docs for Superbuild subdirectory.
- fail to install simpleITK due to gdc HOT 1
- fresh conda env with ImportError: nomodule named '_SimpleITK' on Windows 11 HOT 2
- SIEMENS .ima MagnetomVision files HOT 3
- Release wheels for SimpleITK with Elastix for Ubuntu HOT 1
- Compilation on M1 Error: HOT 1
- CMake hangs on M1 HOT 1
- sitk::ERROR: Pixel type: 32-bit unsigned integer is not supported in 3D byN3itk6simple15MaskImageFilterE HOT 7
- Export `PixelIDValueEnum` members as members of Enum in Python binding
- missing numpy dependency in python wheels and conda package HOT 2
- Move detailed class description to the top of the doc page
- Install on IpadOS v16.6 HOT 2
- RuntimeError: Exception thrown in SimpleITK ImageFileReader_Execute: ../Code/IO/src/sitkImageReaderBase.cxx:97: sitk::ERROR: HOT 1
- Add ImageSeriesReader::SpacingWarningRelThreshold
- SimpleITK getting slower with intense working (JAVA) (memory leak?) HOT 11
- enable ImageFileReader.SetUseStreaming method for JAVA
- SetKernelRadius() does not handle numpy integer types HOT 1
- Extend sitk.ReadImage()/WriteImage() to support pathlib.Path() HOT 1
- add or change the interface for the ImageRegistraitonMethod.SetOptimizerAsAmoeba method HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from simpleitk.