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

Write guidelines for how to talk about new features #2133

Closed
JJ opened this issue Jun 29, 2018 · 0 comments
Closed

Write guidelines for how to talk about new features #2133

JJ opened this issue Jun 29, 2018 · 0 comments
Labels
meta RFCs, general discussion, writing style, repository organization, etc.

Comments

@JJ
Copy link
Contributor

JJ commented Jun 29, 2018

The problem

After introducing allocate in the documentation, #2132 found it didn't work, making people confused.

Suggestions

I would suggest inserting something in the writing guidelines to the tune of:

  • If you are adding a new feature recently introduced in Rakudo, please indicate in a note which version was it introduced in.
  • Try to introduce only documentation for Star versions. Non-star versions should probably wait.
  • If you change an example to use the new feature, leave the old example (at least while it's not obsolete) for people who has not upgraded yet.

What do you think? Any more suggestions? This is related to #302 , but that would be major. This, however, would avoid confusion.

@JJ JJ added the meta RFCs, general discussion, writing style, repository organization, etc. label Jun 29, 2018
@JJ JJ closed this as completed in f67de57 Jul 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta RFCs, general discussion, writing style, repository organization, etc.
Projects
None yet
Development

No branches or pull requests

1 participant