docs: be consistent with recommending self.app and self.unit

Open dwilding opened this issue 8 months ago • 1 comments

This PR starts work on #1783. In the interests of making progress, I've kept the scope focused on docs related to self.app and self.unit.

I've updated several docstrings to hopefully steer people away from using Model.app and Model.unit when CharmBase.app and CharmBase.unit are appropriate. While I was doing this, I also updated some of the wording to be more consistent.

Main updated parts:

Descriptions of Application, Model.app, and Model.get_app()
Descriptions of Unit, Model.unit, and Model.get_unit()
Description of Harness.evaluate_status() - I'm less sure about this one, see my comment

I didn't find any places that needed updating in the markdown source.

Jun 27 '25 03:06 dwilding

@dimaqq would you mind taking a look at this first? No rush to do it this week. When you're happy with it, I'll ask for a second tick. Thanks :slightly_smiling_face:

Jun 27 '25 07:06 dwilding