Mindwerks / worldengine

World generator using simulation of plates, rain shadow, erosion, etc.
MIT License
988 stars 129 forks source link

Preparing documentation for release v0.19.0 #198

Closed ftomassetti closed 8 years ago

ftomassetti commented 8 years ago

This is to address #193

tcld commented 8 years ago

I may have added a lot of comments. Some of the parameters really don't seem clear to me, although most of them certainly could be.

Is the explanation of parameters somehow auto-generated?

ftomassetti commented 8 years ago

It is good to have many comments here. It is true that much stuff is rather obscure. I would try to make definitions more clear. In the long run it would be amazing to have examples on the effect of the single parameters.

For example showing the images generated with different parameters, different values, etc.

ftomassetti commented 8 years ago

Mmmm why this one failed?


======================================================================
FAIL: test_draw_satellite (tests.draw_test.TestDraw)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/travis/build/Mindwerks/worldengine/tests/draw_test.py", line 161, in test_draw_satellite
    self._assert_img_equal("satellite_28070", target)
  File "/home/travis/build/Mindwerks/worldengine/tests/draw_test.py", line 56, in _assert_img_equal
    drawn_image.array[diff[0][0], diff[0][1]]))
AssertionError: Pixels at 0, 0 are different. Blessed [228 228 255 255], drawn [ 24  95 146 255]
----------------------------------------------------------------------
Ran 42 tests in 422.006s
tcld commented 8 years ago

The problem only occurs for one of the Travis-thingies, looks like the code used for the test is not up-to-date - the blessed pixel shows ice (position and colour hint at it), the drawn pixel shows unfrozen ocean (so the icecap-PR is not yet in the code, it seems).

ftomassetti commented 8 years ago

Rebased and restarted the tests, let's see how it goes