procore-oss/blueprinter

Incorrect Transform Documentation

YSavir opened this issue · 2 comments

The documentation for the current version (0.25.3 at time of writing) has the following instructions for transform:

Whatever is returned from this transform method will end up being the resulting hash passed to serialization.

This is incorrect. The return value doesn't seem to be used at all, and any transformations need to be made on the hash argument directly. The example is set up correctly using merge!, but I assumed the focus was still on returning a the mutated hash and not on the mutation itself. This can be seen in the source code here.

Welcome to make a PR to update this doc

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.