Conflicting information in iOS SDK reference and LDClient Class Reference about launchdarkly-docs

[scribblingfox]

Hey @RobotK! Thanks for your close attention to our docs! @bwoskow-ld, can you give some advice here please?

[bwoskow-ld]

The iOS SDK reference page is correct. The difference between the two documented descriptions is subtle. The main reason to be sure to call close is so that your app sends any queued events which have not yet been sent to LaunchDarkly. The iOS SDK reference page makes this clear but the class reference does not.

I'll file a ticket on our internal backlog to improve the class reference. Note that this content is auto-generated from code comments and as such will be fixed in the SDK repository itself, rather than this documentation repository. I'll leave it up to you @scribblingfox to decide if you want to keep this ticket open in the meantime.

[RobotK]

Thanks @bwoskow-ld! I'll update our code appropriately.

[bwoskow-ld]

Closing this ticket for the reasons mentioned in my prior comment -- there's a ticket on our internal backlog to improve the auto-generated API documentation, and there's nothing more to do in this documentation repository.