Comments (2)
document is the a problem for a long time. I did not have much time (you known, sometimes document need more energy than coding), and my english is not very good.
I think there are 3 types of document. sorted by importance:
-
user menual
for ImagePy is a bridge from developer to user. In this point, imagepy.doc folder, we can write some markdown file there, with the same structure and name with the plugins folder. Then it would be linked by the help button on parameter dialog. (if no parameter, or a tool, it is linked by right click), but I just put a demo in it now. (In fact I had tried to write a book, just like many imagej's book, and I has wroten many, but give up temporary) -
the developer document
I think the best way is writting demos. such as the demo plugin. may be some more demos is needed such as how to use ips.data. I think a good framework should be: a science programer can writting plugin easily, and need not know the framework well. -
framework api document
the doxygen document is a framework api, I am reconstructing ImagePy and split the ui as sciwx. When I comleted, we can rebuilt a doxygen.
In the end, may I invite you to imagepy's organization?
from imagepy.
Your classification makes sense. I propose the following:
- User manual
You create the hierarchical document structure. Then we can start writing the documentation. - Developer documentation
You know ImagePy the best, so you could write the documentation (as your time allows) and I can revise it. I am not a native English speaker but I think I could catch some spelling mistakes and also notice if something is not clear. During the revision, I can learn both about Python and the working of ImagePy. - API documentation
Currently, I have no idea concerning this one.
may I invite you to imagepy's organization?
Yes, please. That would allow me to manage labels, milestones, etc. Since I am a beginner Python programmer, I will work on my own fork and contribute in form of pull requests. That way I cannot mess up the main ImagePy repository and you can edit my changes to conform to your needs.
This issue could be pinned on the main page to catch attention. Also, writing the documentation is a larger task, needing some planning. Hence, a project could be set up for this.
from imagepy.
Related Issues (20)
- FIX-..\sciwx\canvas\test.py ----- o, m = mat(self.oribox, self.conbox, csbox)
- error when windows anaconda run imagepy HOT 4
- Create | selection.dic
- A problem occurred when laughing in VS code:Any pushed event handlers must have been removed HOT 5
- I had a problem when launching from a batch file: wx._core.wxAssertionError HOT 3
- Unable to access the X Display, is $DISPLAY set properly? ERR
- No module named 'imagepy.core' HOT 3
- This program needs access to the screen. Please run with a Framework build of python, and only when you are logged in on the main display of your Mac.
- Can I translate it into Chinese HOT 4
- wx._core.wxAssertionError: C++ assertion "!
- ROI add operation doesnt work HOT 1
- Error in atexit._run_exitfuncs HOT 1
- Error in atexit._run_exitfuncs: wx._core.wxAssertionError: C++ assertion "GetEventHandler() == this" failed at ..\..\src\common\wincmn.cpp(474) in wxWindowBase::~wxWindowBase(): any pushed event handlers must have been removed HOT 2
- 大佬您好,咨询问题
- Multi-OS screen capture utility HOT 2
- What causes Simple change the color of an image? HOT 5
- Bug in File - > Save With Mark HOT 1
- Do not run an algorithm again after being accepted in the preview
- pandas table viewer
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 imagepy.