search

next-exp / IC

5 stars 74 forks source link

doc/cities.rst describes solid cities #704

Open jacg opened 4 years ago

jacg commented 4 years ago

This document talks about inheritance etc. This out of date information should be removed! Ideally, it should be replaced by a description of flow-based liquid cities.

This could be a good exercise for someone starting out in dataflow / IC.

mmkekic commented 3 years ago

Reviving the issue! @MCruces-fz has volunteered to help with IC documentation. I believe that the documentation would ideally be done in a style:

I'd start from high level functionalities that are more likely to be used by someone not familiar with IC, but some hints from @jacg and @jjgomezcadenas on how to start would be appreciated. Also @paullglebrun has offered to review the documentation :)

gonzaponte commented 3 years ago

Also, some cities have a description in the docstring at the top of the file. It might be helpful.

jacg commented 3 years ago

technical description of functions/classes with examples

Classes? Are there any of those left? Quick, get rid of them! :-)

but some hints from @jacg and @jjgomezcadenas on how to start would be appreciated.

@jjgomezcadenas understands the high-level structure and the interrelations of the parts much, much better than I do. I'm only really qualified to comment on some of the mid-level structure, essentially how/why to express things in dataflow. Lower-level details (such as implementation choices or strategies of various algorithms) are (in most cases) also outside my area of familiarity. I know a fair bit about paolina, but IIUC that has been deprecated.