Documentation is an essential part of the software development process,
especially when working on a complex system in a collaborative environment
where we want to encourage community growth.
On Wed, Jun 14, 2017 at 10:11 PM, Nakul Jindal wrote:
> Thank you Matthias for
Thank you Matthias for agreeing to do this!
"Having a very verbose doc quickly gets outdated" is a problem many
projects deal with. We can have the community comment on PRs that changes
those parts, if the documentation does not reflect the submitted change.
As a starting point, since you are
sure - I'll try to add some documentation of IPA, probably directly inlined
into the code. Unfortunately, a too verbose dev documentation quickly gets
outdated because nobody updates it - let's see if we find the sweet spot
that works for the project.
Regards,
Matthias
On Wed, Jun 14, 2017 at
Agreed. More documentation, especially within the optimizer portion of the
engine, is quite useful. Given that a large number of our bugs and performance
issues stem from this area, it would be good for it to be clean and well
documented so that future bug searches/fixes can be completed in a
Hi Matthias,
If its not too much trouble, could you please create a design document for
this change.
This will help the rest of the contributors work on this component as well.
Thanks,
Nakul
On Wed, Jun 14, 2017 at 12:00 AM, Matthias Boehm
wrote:
> just a quick heads