Skip to content

Make disclaimer about this not being guarantees a lot more visible #566

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Noratrieb
Copy link
Member

People continue to miss it, and the old disclaimer is easily overlooked when skimming. Make sure that it's more visible.

Additionally, rename all the pages to more clearly say suggestions, making it more visible that those are not guarantees.

Noratrieb added 2 commits May 4, 2025 11:05
People continue to miss it, and the old disclaimer is easily overlooked
when skimming. Make sure that it's more visible.

Additionally, rename all the pages to more clearly say **suggestions**,
making it more visible that those are **not** **guarantees**.
@Noratrieb
Copy link
Member Author

@RalfJung

@ia0
Copy link

ia0 commented May 4, 2025

The Introduction of the Reference says "[This reference] is largely abandoned right now". Is the plan to resurrect it? Or should that disclaimer be made more visible? Or maybe even remove all sections except the Glossary?

@Lokathor
Copy link
Contributor

Lokathor commented May 4, 2025

if parts are known to be not current, we should delete them rather than have bad information in the book.

@Noratrieb
Copy link
Member Author

Noratrieb commented May 4, 2025

I've also thought about unpublishing the entire book off GitHub pages (so it's still present on GitHub but no longer published (or also gone from GitHub)) but I didn't like the idea of making the links dead. On the other hand we could just stub it all out on GitHub pages with a note on why it was removed and where to find the version. I think this is actually the best idea.

@Noratrieb
Copy link
Member Author

Noratrieb commented May 4, 2025

if parts are known to be not current, we should delete them rather than have bad information in the book.

It depends on what we want this book to be. If it's just about accurate descriptions then the entire thing should be deleted, because those belong in the Reference (the real Rust Reference, not this weird book).

@RalfJung
Copy link
Member

RalfJung commented May 4, 2025

I don't have a strong opinion on how to best frame this. However it seems odd that in the table of contents, we now have "suggestions" mixed with things that are not labeled as "suggestions".

Cc @rust-lang/opsem @chorman0773

@chorman0773
Copy link
Contributor

Frankly, my $.02 is that we deprecate the UCG as a whole and transition to making guarantees in the Reference (and other documents like the minirust spec for a more programmatic definition). In my view, this has been the de facto state for the past couple years anyways, with the repo being used as an issue tracker for outstanding technical questions for T-opsem.

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 this pull request may close these issues.

5 participants