add common entry points and instruction to docs - [merged]

[asottile]

In GitLab by @tylerwince on Mar 29, 2018, 08:11

Merges entry_point_docs_update -> master

Per the discussion here: PyCQA/flake8-bugbear#37

Updating the documentation for registering_plugins.rst to reflect the need to choose a unique entry point for flake8 plugins.

[asottile]

In GitLab by @codecov on Mar 29, 2018, 08:12

Codecov Report

Merging #229 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #229   +/-   ##
=======================================
  Coverage   69.97%   69.97%           
=======================================
  Files          27       27           
  Lines        2348     2348           
  Branches      383      383           
=======================================
  Hits         1643     1643           
  Misses        632      632           
  Partials       73       73

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f834499...7635db1. Read the comment docs.

[asottile]

In GitLab by @tylerwince on Mar 30, 2018, 14:46

added 1 commit

• a7c0fc6 - added language for entry point length

Compare with previous version

[asottile]

In GitLab by @tylerwince on Mar 30, 2018, 14:53

added 1 commit

• 7635db1 - fixed emphasis on last line

Compare with previous version

[asottile]

In GitLab by @myii on Mar 30, 2018, 16:36

Closes #308.

[asottile]

In GitLab by @myii on Apr 1, 2018, 15:10

@tylerwince I just had some feedback from @pjacock on a the following GitHub issue:

• Multiple-letter violation codes are not displayed by Vim Syntastic syntax checker peterjc/flake8-rst-docstrings#6.

I think you'll be interested in the link he mentions there about the documentation changes you're making in this MR:

• https://gitlab.com/pycqa/flake8/issues/339

The following quote seems very useful to consider:

Suggested text - not sure where best to put this:

Your new plugin should pick a unique multi-letter alphabetic prefix for its error codes, and append three digits to define unique error codes for each style violation. Using a single letter prefix is now strongly discouraged, as most have been used by earlier plugin developers, meaning error code collisions are very likely.

[asottile]

In GitLab by @sigmavirus24 on Apr 15, 2018, 12:26

excellent ✨ 👍

[asottile]

In GitLab by @sigmavirus24 on Apr 15, 2018, 12:26

merged

[asottile]

In GitLab by @sigmavirus24 on Apr 15, 2018, 12:26

mentioned in commit 730071c