New: `dt-api iterator()` API documentation

* This method already existed, but wasn't publically documented.
  however, I think it is very useful and worth documenting
Update: `dt-api iterator()` updated to execute the callback in the scope of an API instance refering to the table in question
Fix docs: Reference to `dt-init paging` was wrong