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.

Sign up for GitHub

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

Jump to bottom

Rename generator to coroutine #682

Closed
1 of 3 tasks
oli-obk opened this issue Oct 19, 2023 · 3 comments
Closed
1 of 3 tasks

Rename generator to coroutine #682

oli-obk opened this issue Oct 19, 2023 · 3 comments
Labels
major-change A proposal to make a major change to rustc major-change-accepted A major change proposal that was accepted T-compiler Add this label so rfcbot knows to poll the compiler team

Comments

@oli-obk
Copy link
Contributor

oli-obk commented Oct 19, 2023

Proposal

Our generators are more commonly known as coroutines, while generators are a simpler feature. With my rfc about adding generators (that produce Iterators) appearing to not have any major blockers, I would like to fix this naming issue now, before beginning an implementation of generators. Having two different things called "generators" would be immensely confusing to both rustc devs and users.

So, in short: I would like to replace the word "generator" (any capitalization) from rustc and libstd with "coroutine". This includes, but is not limited to,

  • function names
  • trait names
  • data structures
  • diagnostics
  • symbol names
  • lang item names

Mentors or Reviewers

This is just a rename, once seconded and landed, anyone can review this work.

Process

The main points of the Major Change Process are as follows:

  • File an issue describing the proposal.
  • A compiler team member or contributor who is knowledgeable in the area can second by writing @rustbot second.
    • Finding a "second" suffices for internal changes. If however, you are proposing a new public-facing feature, such as a -C flag, then full team check-off is required.
    • Compiler team members can initiate a check-off via @rfcbot fcp merge on either the MCP or the PR.
  • Once an MCP is seconded, the Final Comment Period begins. If no objections are raised after 10 days, the MCP is considered approved.

You can read more about Major Change Proposals on forge.

Comments

This issue is not meant to be used for technical discussion. There is a Zulip stream for that. Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.
@oli-obk oli-obk added T-compiler Add this label so rfcbot knows to poll the compiler team major-change A proposal to make a major change to rustc labels Oct 19, 2023
@rustbot
Copy link
Collaborator

rustbot commented Oct 19, 2023

This issue is not meant to be used for technical discussion. There is a Zulip stream for that. Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.

cc @rust-lang/compiler @rust-lang/compiler-contributors

@rustbot rustbot added the to-announce Announce this issue on triage meeting label Oct 19, 2023
@pnkfelix
Copy link
Member

@rustbot second

@rustbot rustbot added the final-comment-period The FCP has started, most (if not all) team members are in agreement label Oct 19, 2023
@oli-obk oli-obk mentioned this issue Oct 19, 2023
Merged
4 tasks
bors added a commit to rust-lang-ci/rust that referenced this issue Oct 20, 2023
@bors
Auto merge of rust-lang#116958 - oli-obk:coro, r=pnkfelix
44988d1 
rename Generator to Coroutine

implements rust-lang/compiler-team#682

While I did an automated replacement, I went through all changes manually to avoid renaming things like "id generators", "code generator", ...

I renamed files where that was necessary due to the contents referring to the crate name itself (mir opt, codegen or debuginfo tests), or required by tidy (feature gate docs)

* [x] rename various remaining abbreviated references to generators.
* [x] rename files
* [x] rename folders
* [x] add renamed feature: `generators`, ...

r? `@ghost`
bors added a commit to rust-lang-ci/rust that referenced this issue Oct 20, 2023
@bors
Auto merge of rust-lang#116958 - oli-obk:coro, r=pnkfelix
249624b 
rename Generator to Coroutine

implements rust-lang/compiler-team#682

While I did an automated replacement, I went through all changes manually to avoid renaming things like "id generators", "code generator", ...

I renamed files where that was necessary due to the contents referring to the crate name itself (mir opt, codegen or debuginfo tests), or required by tidy (feature gate docs)

* [x] rename various remaining abbreviated references to generators.
* [x] rename files
* [x] rename folders
* [x] add renamed feature: `generators`, ...

r? `@ghost`
github-actions bot pushed a commit to rust-lang/miri that referenced this issue Oct 21, 2023
@bors
Auto merge of #116958 - oli-obk:coro, r=pnkfelix
c111936 
rename Generator to Coroutine

implements rust-lang/compiler-team#682

While I did an automated replacement, I went through all changes manually to avoid renaming things like "id generators", "code generator", ...

I renamed files where that was necessary due to the contents referring to the crate name itself (mir opt, codegen or debuginfo tests), or required by tidy (feature gate docs)

* [x] rename various remaining abbreviated references to generators.
* [x] rename files
* [x] rename folders
* [x] add renamed feature: `generators`, ...

r? `@ghost`
@apiraino
Copy link
Contributor

@rustbot label -final-comment-period +major-change-accepted

@rustbot rustbot added major-change-accepted A major change proposal that was accepted and removed final-comment-period The FCP has started, most (if not all) team members are in agreement labels Oct 24, 2023
@apiraino apiraino removed the to-announce Announce this issue on triage meeting label Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
major-change A proposal to make a major change to rustc major-change-accepted A major change proposal that was accepted T-compiler Add this label so rfcbot knows to poll the compiler team
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@pnkfelix @oli-obk @apiraino @rustbot