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

Modify package in the README.md to mark unreviewed ideas as provisional. #2324

Merged
merged 5 commits into from
Oct 20, 2022
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/design/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2103,6 +2103,11 @@ to coordinate to avoid name conflicts, but not across packages.

### Package declaration

> **Note:** This is provisional, designs for a default package, making the
> package name optional, and omitting the `package` declaration have not been
> through the proposal process yet. See
> [#2323](https://github.com/carbon-language/carbon-lang/issues/2323).

Files start with an optional package declaration, consisting of:

- the `package` keyword introducer,
Expand All @@ -2125,8 +2130,10 @@ Parts of this declaration may be omitted:
- If the package name is omitted, as in `package library "Main" api;`, the
file contributes to the default package. No other package may import from
the default package.

- If the library keyword is not specified, as in `package Geometry api;`, this
file contributes to the default library.

- If a file has no package declaration at all, it is the `api` file belonging
to the default package and default library. This is particularly for tests
and smaller examples. No other library can import this library even from
Expand All @@ -2145,6 +2152,10 @@ default package.

### Imports

> **Note:** This is provisional, designs for making the package name optional
> have not been through the proposal process yet. See
> [#2323](https://github.com/carbon-language/carbon-lang/issues/2323).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way to phrase this so it is clear that, while it hasn't been through the proposal process, it was decided in #1136 ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would just add that issue to the tracking one Jon filed, not sure it's worth tracking here as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adjusted to reference #2001 for tracking.

After the package declaration, files may include `import` declarations. These
include the package name and optionally `library` followed by the library name.
If the library is omitted, the default library for that package is imported.
Expand Down