Skip to content

chore: improve code style guide#38715

Merged
dipikabh merged 1 commit intomdn:mainfrom
bsmth:code_style_guide
Mar 21, 2025
Merged

chore: improve code style guide#38715
dipikabh merged 1 commit intomdn:mainfrom
bsmth:code_style_guide

Conversation

@bsmth
Copy link
Copy Markdown
Member

@bsmth bsmth commented Mar 19, 2025

Description

A general refresh on the code style document for readability.

Motivation

Recently edited this page and found some opportunities for small tidy up.

@bsmth bsmth requested a review from a team as a code owner March 19, 2025 13:35
@bsmth bsmth requested review from pepelsbey and removed request for a team March 19, 2025 13:35
@github-actions github-actions bot added Content:Meta Content in the meta docs size/m [PR only] 51-500 LoC changed labels Mar 19, 2025
@github-actions
Copy link
Copy Markdown
Contributor

Preview URLs

External URLs (2)

URL: /en-US/docs/MDN/Writing_guidelines/Code_style_guide
Title: Guidelines for writing code examples

Copy link
Copy Markdown
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

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

Great improvements 👏 Thank you!

@dipikabh dipikabh merged commit 782bf32 into mdn:main Mar 21, 2025
7 checks passed
@bsmth bsmth deleted the code_style_guide branch March 21, 2025 17:48
wbamberg added a commit to wbamberg/content that referenced this pull request Apr 4, 2025
* upstream/main: (172 commits)
  chore: improve code style guide (mdn#38715)
  fix: typo on `Error.isError()` page (mdn#38754)
  plural consistency (mdn#38747)
  fix: auto-cleanup by bot (mdn#38695)
  Synchronize with BCD v5.7.4 (mdn#38709)
  Add docs for JS self-profiling API (mdn#37796)
  Better SameSite docs (mdn#38710)
  Added missing explanation for Array Literals (mdn#38745)
  Add a page on CSRF (mdn#38151)
  Fix description of several Range methods (mdn#38518)
  Remove extraneous span (mdn#38696)
  Add a definition for media containers, improve how the media files are defined and Remove wrong information (mdn#38721)
  Move visited selector guide to CSS selectors module (mdn#38642)
  Make JSON learning article more technically precise (mdn#38644)
  Make translate3d() interactive example code valid (mdn#38647)
  Clarity on Safari support for custom elements (mdn#38727)
  feat(css): Link to learning doc about text direction (mdn#38719)
  Fix typo (mdn#38739)
  move guide to module: inline formatting context (mdn#38637)
  Fix CSS pseudo-class lists (mdn#38576)
  ...
cssinate pushed a commit to cssinate/content that referenced this pull request Apr 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content:Meta Content in the meta docs size/m [PR only] 51-500 LoC changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants