Ticket #5156 enhancement closed fixed

Opened 3 years ago

Last modified 3 years ago

no ambiguous antecedents (plugins documentation edition)

Reported by: exarkun Owned by: exarkun
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: Branch: branches/ambiguous-antecedents-5156
(diff, github, buildbot, log)
Author: indigo Launchpad Bug:

Description (last modified by exarkun) (diff)

In the "Alternate Plugin Packages" section of the plugin howto document, these sentences appear:

However, if you have developed an interface of your own, you may want to mandate that plugins for it are installed in your own plugins package, rather than in Twisted's. In this case, you probably also want to support yourproject/plugins/ directories for ease of development. To do so, you should make the __init__.py for that package contain at least the following lines.

Followed by a code snippet to put in said __init__.py. However, the phrasing of the last sentence, for that package, is ambiguous. It could refer to either yourproject or yourproject.plugins. It should be clarified that this documentation is referring to the __init__.py for yourproject.plugins, ie yourproject/plugins/__init__.py.

Attachments

plugins-ambiguous-antecedents-5156.patch Download (0.9 KB) - added by indigo 3 years ago.

Change History

1

  Changed 3 years ago by exarkun

  • description modified (diff)

2

in reply to: ↑ description   Changed 3 years ago by jafd

In this case, you probably also want to support yourproject/plugins/ directories for ease of development. To do so, you need to make yourproject/plugins directory a regular Python package, and its __init__.py should contain at least the following lines.

Would that be okay?

Changed 3 years ago by indigo

3

  Changed 3 years ago by indigo

  • keywords review added

please review. merge with .misc topfile?

4

  Changed 3 years ago by exarkun

  • branch set to branches/ambiguous-antecedents-5156
  • branch_author set to exarkun

(In [32747]) Branching to 'ambiguous-antecedents-5156'

5

  Changed 3 years ago by exarkun

(In [32748]) Apply plugins-ambiguous-antecedents-5156.patch

refs #5156

6

  Changed 3 years ago by exarkun

  • keywords review removed
  • owner set to exarkun
  • branch_author changed from exarkun to indigo

Thanks for taking a look at this.

  1. There's a typo in the first new sentence.
  2. I don't think supporting these plugins directories is an example. It's just something you might want to do. So the "For example" is off-putting.

Otherwise fine. I'll tweak that first sentence trivially and apply. Thanks again.

7

  Changed 3 years ago by exarkun

(In [32749]) Fix typo, tweak phrasing

refs #5156

8

  Changed 3 years ago by exarkun

  • status changed from new to closed
  • resolution set to fixed

(In [32751]) Merge ambiguous-antecedents-5156

Author: indigo Reviewer: exarkun Fixes: #5156

Clarify the language in the plugin howto regarding how to create new splittable plugin-holding directories (in the way twisted/plugins/ can exist in multiple places and have all contents merged).

Note: See TracTickets for help on using tickets.