Skip to content

Conversation

@scrc-cg-pr-from-issue
Copy link
Contributor

This PR was automatically generated from issue #174.

Authored by: @felix91gr

Closes #174.

@netlify
Copy link

netlify bot commented Aug 23, 2025

Deploy Preview for scrc-coding-guidelines ready!

Name Link
🔨 Latest commit 9382fa4
🔍 Latest deploy log https://app.netlify.com/projects/scrc-coding-guidelines/deploys/69236cf250fa550009b8d27a
😎 Deploy Preview https://deploy-preview-181--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.

@PLeVasseur
Copy link
Collaborator

@felix91gr -- could you add the new tag you're using in another PR?

Note that this fails for the same reason as over in #180, so if you addressed the tags over there, you're good.

@felix91gr
Copy link
Collaborator

There are a few things regarding the formatting that I can't quite figure out.

@PLeVasseur who from the core team knows the most about Sphinx? There are a few oddities in rendering that I've noticed as I've seen the document change with the PRs, of which I can't pinpoint the cause. Stuff like some bulleted lists having a lot of spacing between their bullet and their text, to some text of the document being obscured by the page's background. So I was thinking that perhaps I could ask for help in finding the causes of those.

@felix91gr
Copy link
Collaborator

(Also I'm doing the tables by hand, as you suggested :) took me a while to get to it, but I'm on it)

@felix91gr
Copy link
Collaborator

Also: I just fixed a typo because CI rejected the PR due to some unrelated document having a typo. Should this be on another PR?

Anywho. I'll be fixing the table on the other open PR, you tell me how we should merge the typo fix and then we can finally merge both guidelines x3

@felix91gr
Copy link
Collaborator

Nevermind. I'll just fix that in another PR. Otherwise iterating on this one will be a pain.

@felix91gr
Copy link
Collaborator

#206 has the typo fix

@felix91gr felix91gr added coding guideline An issue related to a suggestion for a coding guideline chapter: expressions decidability: undecidable A coding guideline which cannot be checked automatically category: mandatory A coding guideline with category mandatory labels Oct 4, 2025
@felix91gr felix91gr requested a review from PLeVasseur October 7, 2025 16:09
@felix91gr felix91gr force-pushed the guideline-174 branch 2 times, most recently from e94e531 to 7380725 Compare October 7, 2025 16:21
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.

Good to see this working with the manual table.

Content-wise this is good.

There's a couple of formatting snags I pointed out.

@PLeVasseur
Copy link
Collaborator

Well that's new 😅

Pulled from here.

5:15:56 PM: Build command from Netlify app                                
5:15:56 PM: ────────────────────────────────────────────────────────────────
5:15:56 PM: ​
5:15:56 PM: $ curl -LsSf https://astral.sh/uv/install.sh | sh && ./make.py
5:15:56 PM: downloading uv 0.9.4 x86_64-unknown-linux-gnu
5:15:56 PM: no checksums to verify
5:15:56 PM: installing to /opt/buildhome/.local/bin
5:15:56 PM:   uv
5:15:56 PM:   uvx
5:15:56 PM: everything's installed!
Using CPython 3.14.0 interpreter at: /opt/buildhome/.local/share/mise/installs/python/3.14.0/bin/python3
5:15:56 PM: Creating virtual environment at: .venv
5:15:56 PM:    Building builder @ file:///opt/build/repo/builder
5:15:56 PM:    Building m2r==0.3.1
5:15:56 PM: Downloading pygments (1.2MiB)
5:15:56 PM: Downloading sphinx-needs (2.5MiB)
5:15:56 PM: Downloading sphinx (3.4MiB)
5:15:56 PM: Downloading babel (9.7MiB)
5:15:56 PM: Downloading sphinx-rtd-theme (7.3MiB)
5:15:56 PM: Downloading ruff (11.1MiB)
5:15:57 PM:    Building rpds-py==0.23.1
5:15:57 PM:    Building markupsafe==3.0.2
5:15:57 PM:    Building watchfiles==1.0.5
5:15:57 PM:  Downloading pygments
5:15:57 PM:  Downloading ruff
5:15:57 PM:  Downloading sphinx-rtd-theme
5:15:57 PM:  Downloading sphinx-needs
5:15:57 PM:  Downloading sphinx
5:15:57 PM:  Downloading babel
5:15:57 PM:   × Failed to build `watchfiles==1.0.5`
5:15:57 PM:   ├─▶ The build backend returned an error
5:15:57 PM:   ╰─▶ Call to `maturin.build_wheel` failed (exit status: 1)
5:15:57 PM:       [stdout]
5:15:57 PM:       Running `maturin pep517 build-wheel -i
      /opt/buildhome/.cache/uv/builds-v0/.tmpZv6bLS/bin/python --compatibility
      off`
5:15:57 PM:       [stderr]
5:15:57 PM:       error: rustup could not choose a version of cargo to run, because one
5:15:57 PM:       wasn't specified explicitly, and no default is configured.
      help: run 'rustup default stable' to download the latest stable release
5:15:57 PM:       of Rust and set it as your default toolchain.
5:15:57 PM:       💥 maturin failed
5:15:57 PM:         Caused by: Cargo metadata failed. Does your crate compile with `cargo
      build`?
5:15:57 PM:         Caused by: `cargo metadata` exited with an error:
5:15:57 PM:       Error: command ['maturin', 'pep517', 'build-wheel', '-i',
5:15:57 PM:       '/opt/buildhome/.cache/uv/builds-v0/.tmpZv6bLS/bin/python',
5:15:57 PM:       '--compatibility', 'off'] returned non-zero exit status 1
5:15:57 PM:       hint: This usually indicates a problem with the package or the build
5:15:57 PM:       environment.
5:15:57 PM:   help: `watchfiles` (v1.0.5) was included because
5:15:57 PM:         `safety-critical-rust-coding-guidelines` (v0.1.0) depends on
5:15:57 PM:         `sphinx-autobuild` (v2024.10.3) which depends on `watchfiles`
5:15:57 PM: ​
5:15:57 PM: "build.command" failed                                        
5:15:57 PM: ────────────────────────────────────────────────────────────────
5:15:57 PM: ​
5:15:57 PM:   Error message
5:15:57 PM:   Command failed with exit code 1: curl -LsSf https://astral.sh/uv/install.sh | sh && ./make.py (https://ntl.fyi/exit-code-1)
5:15:57 PM: ​
5:15:57 PM:   Error location
5:15:57 PM:   In Build command from Netlify app:
5:15:57 PM:   curl -LsSf https://astral.sh/uv/install.sh | sh && ./make.py
5:15:57 PM: ​
5:15:57 PM:   Resolved config
5:15:57 PM:   build:
5:15:57 PM:     command: curl -LsSf https://astral.sh/uv/install.sh | sh && ./make.py
5:15:57 PM:     commandOrigin: ui
5:15:57 PM:     environment:
5:15:57 PM:       - REVIEW_ID
5:15:57 PM:     publish: /opt/build/repo/build/html
5:15:57 PM:     publishOrigin: ui
5:15:57 PM: Build failed due to a user error: Build script returned non-zero exit code: 2
5:15:58 PM: Failed during stage 'building site': Build script returned non-zero exit code: 2 (https://ntl.fyi/exit-code-2)
5:15:58 PM: Failing build: Failed to build site
5:15:58 PM: Finished processing build request in 12.349s

@PLeVasseur
Copy link
Collaborator

I wonder if there's a good way to re-run this.

I see no way immediately to do so when clicking on the failed Netlify step
image

@felix91gr
Copy link
Collaborator

felix91gr commented Oct 21, 2025

I added some whitespace to the commit message @PLeVasseur, which re-triggered the Netlify deploy. However, it still errors out. So whatever is broken over there, must still be broken 🤔

@PLeVasseur
Copy link
Collaborator

Opened #212 to track to resolution so that we can get this build to pass.

@PLeVasseur
Copy link
Collaborator

@felix91gr -- please rebase and push. Build should work now

@felix91gr
Copy link
Collaborator

@PLeVasseur I just did. For some reason, Netlify is still trying to build it with Python 3.14 🤔

@PLeVasseur
Copy link
Collaborator

Okay, I put #180 onto the merge queue. I think this one need only be rebased, right?

Co-authored-by: felix91gr <felix91gr@users.noreply.github.com>

Note: tables were written by hand due to limitations in our automation
@felix91gr
Copy link
Collaborator

@PLeVasseur it should be ready now :)

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.

LGTM!

@PLeVasseur PLeVasseur added this pull request to the merge queue Nov 25, 2025
Merged via the queue into main with commit 57b6ba6 Nov 25, 2025
6 checks passed
@PLeVasseur PLeVasseur deleted the guideline-174 branch November 25, 2025 15:53
MarcosBorgesPhD pushed a commit to MarcosBorgesPhD/safety-critical-rust-coding-guidelines that referenced this pull request Dec 2, 2025
Co-authored-by: felix91gr <felix91gr@users.noreply.github.com>

Note: tables were written by hand due to limitations in our automation

Co-authored-by: felix91gr <11747623+felix91gr@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

category: mandatory A coding guideline with category mandatory chapter: expressions coding guideline An issue related to a suggestion for a coding guideline decidability: undecidable A coding guideline which cannot be checked automatically

Projects

None yet

3 participants