Skip to content

Conversation

scrc-cg-pr-from-issue[bot]
Copy link

This PR was automatically generated from issue #174.

Authored by: @felix91gr

Closes #174.

Copy link

netlify bot commented Aug 23, 2025

Deploy Preview for scrc-coding-guidelines ready!

Name Link
🔨 Latest commit 7380725
🔍 Latest deploy log https://app.netlify.com/projects/scrc-coding-guidelines/deploys/68e53e290a24de00081a3b54
😎 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
Co-authored-by: felix91gr <[email protected]>

Note: tables were written by hand due to limitations in our automation
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
2 participants