search

lucendio / reflowd_thesis

Master's Thesis: ReFlowd
Other
2 stars 2 forks source link

Improve figure descriptions #23

Closed 0ndorio closed 7 years ago

0ndorio commented 7 years ago

review phase: 3 level: opinion type: content ref: all

Reason (if not obvious)?

As far as I am concerned the descriptions of a figure should not only contain the name but also a short description of the image. This increases their meaningfulness and allows a potential reader to understand them, so that he doesn't need to scan the text to find the actual related section.

lucendio commented 7 years ago

technically possible, but debatable. I am able to add more text to a figure name with different level of emphasising, e.g.

![__PDaaS Architecture, centralized composition__ some more text](./assets/figures/pdaas_component-composition_centralized.png){#fig:composition-centralized}

but then the whole description is in the ToF as well, which is not desired. so either I leave the description as minimalistic as is (with minor changes) and as close to then mentioning in the text or I remove the ToF. I rather prefer the first approach.

0ndorio commented 7 years ago

Already the second issue where you mention that you have to work around a limitation of your conversion tool. 👎 And removing the ToF is no option so keep the short descriptions.