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

API Documentation objectives for 1.6 #29429

Closed
steveklabnik opened this Issue Oct 28, 2015 · 4 comments

Comments

Projects
None yet
1 participant
@steveklabnik
Member

steveklabnik commented Oct 28, 2015

These are the parts of the API documentation that I'm going to try to handle during the 1.6 release. To start, I'm going to:

  1. Keep it small. This is a new process, so I want to try to under-estimate, not over-estimate.
  2. Focus on impact. This first round should be the stuff that's really, really important. It's all important, but still. More common stuff first.
  3. Choose some things which I think may already be done. I've been putting a lot of work into Iterator lately, for example, so it's going here, because that way it can be checked off.

With that out of the way, here's the plan:

@steveklabnik

This comment has been minimized.

Show comment
Hide comment
@steveklabnik

steveklabnik Nov 4, 2015

Member

#29552 is a regression in nightly that should be fixed before 1.6.

Member

steveklabnik commented Nov 4, 2015

#29552 is a regression in nightly that should be fixed before 1.6.

@steveklabnik

This comment has been minimized.

Show comment
Hide comment
@steveklabnik

steveklabnik Nov 12, 2015

Member

Note, I'm checking the list off when I feel good about it, but aren't closing the issues until the week before the release. Want to go over them and make sure before it gets closed.

Member

steveklabnik commented Nov 12, 2015

Note, I'm checking the list off when I feel good about it, but aren't closing the issues until the week before the release. Want to go over them and make sure before it gets closed.

@steveklabnik

This comment has been minimized.

Show comment
Hide comment
@steveklabnik

steveklabnik Dec 1, 2015

Member

Whew! regression fixed, and PRs submitted for the basics of all of this. Once they all land, I will do a once-over and make sure I'm happy with the results.

Member

steveklabnik commented Dec 1, 2015

Whew! regression fixed, and PRs submitted for the basics of all of this. Once they all land, I will do a once-over and make sure I'm happy with the results.

bors added a commit that referenced this issue Dec 10, 2015

Auto merge of #30293 - steveklabnik:fixes, r=brson
I meant to double check the work in #29429, but due to Mozlando, forgot. Here are two small fixes.

r? @brson I would like to get this backported to beta as well, sorry :( I don't generally want doc backports, but feel this is exceptional and worth it.
@steveklabnik

This comment has been minimized.

Show comment
Hide comment
@steveklabnik

steveklabnik Dec 14, 2015

Member

Since 1.6 is now in beta, this can be closed. I'm not closing the individual issues due to conventions issues, just yet.

Member

steveklabnik commented Dec 14, 2015

Since 1.6 is now in beta, this can be closed. I'm not closing the individual issues due to conventions issues, just yet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment