urbanopt / urbanopt.github.io

Documentation for URBANopt
Other
1 stars 3 forks source link

DOCUMENTATION: add mapper inheritance documentation #89

Closed kflemin closed 3 years ago

kflemin commented 4 years ago

When a mapper inherits from another, make sure to require that other mapper first. Urbanopt cannot guarantee the order in which mappers are added (it various based on os) and can trigger errors.

example: this line: https://github.com/urbanopt/urbanopt-example-geojson-project/blob/develop/mappers/HighEfficiency.rb#L35

relates to this line: https://github.com/urbanopt/urbanopt-example-geojson-project/blob/develop/mappers/HighEfficiency.rb#L41

add documentation and an example to this page: https://docs.urbanopt.net/customization/new_mapper_class.html

vtnate commented 3 years ago

This was resolved with #91. Closing it now.