Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Problem: The current shortnames are weird and hard to use/remember #32

Open
2 of 3 tasks
ttmc opened this issue Apr 18, 2018 · 2 comments
Open
2 of 3 tasks

Problem: The current shortnames are weird and hard to use/remember #32

ttmc opened this issue Apr 18, 2018 · 2 comments
Assignees

Comments

@ttmc
Copy link
Contributor

ttmc commented Apr 18, 2018

Problem Description

The current shortnames, such as 4/STANDARDIZE-DC and 6/SWP are hard to use and remember. Do you remember what DC or SWP stands for? Will you remember in a year?

Proposal

In practice, we've actually been using things like BEP4, BEP-4, BEP 4, or BEP#4, because that's much easier to say and to look up. The proposal is just to make that the official "short" way that we reference BEPs.

I think the Python community already does this when they refer to their PEPs, such as PEP-8.

Let's just change all the "shortname" labels to say BEP-N, where N is the BEP number.

Let's also do some searches for "1/C4" and "2/COSS" and replace those with BEP-1 and BEP-2. I think those are the only two shortnames we ever actually used.

@ttmc ttmc self-assigned this Apr 18, 2018
@vrde
Copy link
Contributor

vrde commented Apr 18, 2018

I totally agree!

We can even remove shortname and have number from BEP-2. It's still in draft, and we can change it:

When raw BEPs can be demonstrated, they become draft BEPs. Changes to draft BEPs should be done in consultation with users. Draft BEPs are contracts between the editors and implementers.

We would need to update all the BEPs, it's feasible, we don't have many.

@ttmc
Copy link
Contributor Author

ttmc commented Oct 14, 2018

This issue is mostly resolved. The only thing left to do is update the pull request to create BEP-11: pull request #57. I'm not able to update that pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants