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

Clarify the status of paragraph identifiers #1573

Closed
mattheww opened this issue Aug 14, 2024 · 1 comment · Fixed by #1594
Closed

Clarify the status of paragraph identifiers #1573

mattheww opened this issue Aug 14, 2024 · 1 comment · Fixed by #1594
Assignees

Comments

@mattheww
Copy link
Contributor

I see the master branch now contains some of the new C++-style paragraph identifiers (strings like [asm.rules.mem-same-as-ffi]).

I think it's important that the Reference's introduction should say something about what those identifiers are, and what expectations readers should have about their stability.

(In the C++ world, these identifiers have historically been very stable between standards and drafts, and of course each standard itself lasts for several years.)

Is there an intention that as long as a particular identifier is present the text it covers will have the same meaning (assuming the Rust language itself doesn't change)?

Should readers expect that when the Reference's text is improved the previously-existing identifiers will still be present?

In particular, it would be good to say whether it's reasonable to rely on these identifiers from an external long-lasting document, without also quoting the text or noting the version of the Reference it came from.

For example, is it appropriate to use these identifiers in a Rust RFC?

@ehuss
Copy link
Contributor

ehuss commented Aug 22, 2024

Yea, we definitely should have that documented. I'll open a PR soon to add a description of what the rules are.

For the short term, I think we will say that the identifiers won't be stable as we may be reworking some parts. However our goal is definitely to have them be stable (or at least with redirects if we ever rename things).

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

Successfully merging a pull request may close this issue.

2 participants