Skip to content

Commit abbdb97

Browse files
committed
Add remaining tasks to the documentation
1 parent 226cc0f commit abbdb97

File tree

1 file changed

+96
-1
lines changed

1 file changed

+96
-1
lines changed

docs/source/developing.rst

Lines changed: 96 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,102 @@ Deployment scripts are generated with `gitploy`_.
132132
#. Run ``python -m gitploy`` in ``shapeflow``\ ‘s root directory.
133133

134134

135+
TODO
136+
----
137+
138+
Some known problems and minor feature ideas. Not everything in this list is
139+
worth spending time on, and some ideas are serious feature creep.
140+
Open `issues`_ for important stuff.
141+
142+
* Check performance on slower hardware
143+
144+
* Sidebar nav icon&text should aligned vertically
145+
146+
* Frame & state image can get desynchronized sometimes
147+
148+
* Dragging the seek control doesn't update streams, but clicking/arows do
149+
(sometimes, sometimes it's ok)
150+
151+
* Alt scrolls through sidebar navs for some reason
152+
153+
* Select previous results of the same analyzer in the results page
154+
155+
* Masks misbehave when increasing DPI,
156+
work fine when decreasing DPI (????)
157+
158+
* Skipped masks should be grayed out in the state image
159+
160+
* Set a max width/height for graph (depending on number of features?)
161+
162+
* Add ``AnalyzerState`` assertions to test_main.py
163+
164+
* Sometimes roi resize gets applied to current & opposite side, jumpy
165+
166+
* Highlight masks on hover in frontend
167+
168+
* Set default filter/transform configuration when adding a new analysis
169+
170+
* Optimize ``SchemaForm`` rendering speed
171+
172+
* Add an option to export ``.meta`` files
173+
174+
* Add an option to import analyses from ``.meta`` files and ``.xlsx`` files
175+
176+
* Configure sidebar should have a fade on the bottom
177+
178+
* Don't catch events outside of frame boundary (``v-bind`` ``style`` to ``div``?)
179+
180+
* *Really* fix oscillating parameter override categories
181+
182+
* Two of the same feature should yield two separate graphs
183+
184+
* On Windows, ``tkinter`` file dialogs don't open when debugging
185+
186+
* Support Anaconda environments
187+
188+
* When current analyzer page becomes disabled, route away or gray out page
189+
190+
191+
Already fixed?
192+
==============
193+
194+
* ``get_overlay`` & ``get_overlay_png`` take 5 seconds to run sometimes
195+
196+
* Align/Filter page: seek event on page load doesn't always come through,
197+
or the streamed image doesn't get updated
198+
199+
* Frontend can freeze when adding a second/third/... analyzer
200+
201+
* Adding new analyzers with large Nf is slow
202+
203+
* Fix ROI rotation
204+
(probably need to initialize moveable with the aspect ratio of the design)
205+
206+
* ``ConfigModel`` is made in doubles
207+
208+
* CtrlZ / CtrlShiftZ requests ``undo_config``/``redo_config`` twice
209+
210+
* When switching between analyzers, ROI sometimes gets stuck;
211+
modifying ``moveable`` doesn't cause actual ROI to jump to the wrong one
212+
213+
* Config events are sometimes missed on ``set_filter_click``
214+
215+
* Issues with page rebuild after switching analyzers multiple (3+ times)
216+
217+
* Shouldn't continue on to ``/api/va/<id>/launch`` if ``/api/va/<id>/set_config`` raises HTTP500
218+
219+
* Reset filters state update should disable 'Analyze' button
220+
221+
222+
223+
224+
225+
226+
227+
228+
135229
.. _npm: https://www.npmjs.com/get-npm
136230
.. _vue-hot-reload: https://vue-loader.vuejs.org/guide/hot-reload.html
137231
.. _gitploy: https://github.com/ybnd/gitploy
138-
.. _ploy: https://github.com/ybnd/shapeflow/blob/master/shapeflow/setup/ploy
232+
.. _ploy: https://github.com/ybnd/shapeflow/blob/master/shapeflow/setup/ploy
233+
.. _issues: https://github.com/ybnd/shapeflow/issues

0 commit comments

Comments
 (0)