subdgtl / Monoceros

Wave Function Collapse plug-in for Grasshopper
MIT License
63 stars 13 forks source link

Review of the work so far #6

Closed yanchith closed 3 years ago

yanchith commented 3 years ago

The review branch was created from the initial commit. This PR encompasses all the changes since that commit.

janper commented 3 years ago

Thank you for your feedback. Some of the comments are of a high value.

As for the formatting, C# seems to be quite benevolent and therefore there are not many autoformatting options available. For the current formatting I used Microsoft's official .editorconfig for Azure applications. It seems to ignore the whitespaces in some cases (in other cases it fixes them) but requires the documentation. Therefore it is almost everywhere and only occasionally I kept the autogenerated version (mostly GetHashCode, if not only there). I find the documentation useful and with an appropriate editor it also renders well and helps understanding the classes, methods and their params. There is some redundancy and I'll have a look into it.

yanchith commented 3 years ago

I find the documentation useful and with an appropriate editor

What editor do you use? I viewed the docs in Visual Studio too and see the same thing. At least I really struggle to read this. Can your mind ignore all the XML noise?

image

janper commented 3 years ago

I find the documentation useful and with an appropriate editor

What editor do you use? I viewed the docs in Visual Studio too and see the same thing. At least I really struggle to read this. Can your mind ignore all the XML noise?

Visual Studio 2019 - hover over the name or start typing. image

yanchith commented 3 years ago

This has served its purpose, we will open another one for the more in-depth code review now that design is more stable.