diff --git a/DEVELOPER-NOTES.md b/DEVELOPER-NOTES.md index a718b815f..4e6d35426 100644 --- a/DEVELOPER-NOTES.md +++ b/DEVELOPER-NOTES.md @@ -73,7 +73,8 @@ public: ### Function Parameter calling conventions * Objects which are passed as read-only with no transfer of ownership - should be passed as `const` references (`const Geometry&`). + should be passed as `const` [references](https://en.wikipedia.org/wiki/Reference_%28C++%29#) (e.g. `const Geometry&`). + References are simpler and safer to use than pointers. * in particular, this applies to Geometry objects passed to API operations (in static functions, class constructors, or initialization methods) * NOTE: many GEOS API functions use pass-by-pointer (`Geometry*`), but this is historical baggage @@ -135,4 +136,4 @@ In **implementation files**, `using` [declarations](https://en.cppreference.com/ ``` using geos::algorithm::Distance; using namespace geos::geom; -``` \ No newline at end of file +```