Skip to content

Conversation

AlexCeleste
Copy link
Collaborator

This adds a basic example of three kinds of guideline:

  • a blanket Advisory subsetting guideline
  • a more targeted decidable Required subsetting guideline
  • a defect-oriented undecidable Required guideline

AlexCeleste and others added 3 commits June 4, 2025 15:53
…n explicit Amplification section exists (instead, whatever paragraph immediately opens the guideline is just normative). We can continue to call it that but the subheading is not necessary.
Copy link

netlify bot commented Jun 4, 2025

Deploy Preview for scrc-coding-guidelines ready!

Name Link
🔨 Latest commit 9b6f943
🔍 Latest deploy log https://app.netlify.com/projects/scrc-coding-guidelines/deploys/687ed770ba4906000846686f
😎 Deploy Preview https://deploy-preview-127--scrc-coding-guidelines.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Collaborator

@PLeVasseur PLeVasseur left a comment

Choose a reason for hiding this comment

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

Thanks @AlexCeleste for the excellent additions! Could you take a look at the comments I left?

By the way -- I think I recall you saying the plan is to incorporate these examples more into the Style Guideline to help flesh it out. Was that right? In this PR or another?

I suppose then it would be quite helpful to use the examples to illustrate the difference between a defect and subset.

Copy link
Contributor

@iglesias iglesias left a comment

Choose a reason for hiding this comment

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

I've checked the additions a few times over the past weeks and they look quite good to me overall.

Copy link
Collaborator

@PLeVasseur PLeVasseur left a comment

Choose a reason for hiding this comment

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

Left a couple of thoughts! Thanks a bunch for sweeping through and addressing comments @AlexCeleste

Copy link
Collaborator

@PLeVasseur PLeVasseur left a comment

Choose a reason for hiding this comment

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

Missed a comment. Realized we can also use the linking to the standard library for core and other standard library crates as well 🥳

Copy link
Collaborator

@PLeVasseur PLeVasseur left a comment

Choose a reason for hiding this comment

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

I think we're almost there! Last question about choice of ETF RFC 2119-styling on one section.

Copy link
Collaborator

@PLeVasseur PLeVasseur left a comment

Choose a reason for hiding this comment

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

Also -- seems as though the double backtick syntax for Guideline title isn't working here:

image

Could you either remove the backticks or look into how to get this to still render correctly as inline code?

Copy link
Collaborator

@PLeVasseur PLeVasseur left a comment

Choose a reason for hiding this comment

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

Thanks @AlexCeleste for these excellent examples and fleshing out the style guidelines!

@PLeVasseur PLeVasseur added this pull request to the merge queue Jul 23, 2025
Merged via the queue into rustfoundation:main with commit 0c2e50f Jul 23, 2025
6 checks passed
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