Skip to content

Add some missing yamllint config settings to .yamllint.yaml - #8381

Open
mhucka wants to merge 2 commits into
quantumlib:mainfrom
mhucka:yamllint-config-update
Open

mhucka wants to merge 2 commits into
quantumlib:mainfrom
mhucka:yamllint-config-update

Conversation

@mhucka

@mhucka mhucka commented Sep 26, 2026

Copy link
Copy Markdown
Contributor

There are no code changes in this PR.

The .yamllint.yaml configuration did not include an extends: property, and it turns out that this meant yamllint never checked certain things at all. This PR adds extends: relaxed to get most of the default yamllint checks without being too pedantic about it. However, it does modify the rules in two cases to be stricter about indentation of lists and comments.

All other file changes other than to .yamllint.yaml in this PR are simply to adjust formatting in other files to comply with the updated configuration.

After this is merged, the merge commit hash should probably be added to .git-blame-ignore-revs.

The `.yamllint.yaml` configuration did not include an `extends:`
property, and it turns out that this mean `yamllint` never checked
certain things at all. This PR adds `extends: relaxed` to get most of
the default checks without being too pedantic about it. It does modify
the rules, however, to be stricter about indentation.

The other file changes in this PR are simply to make some files comply
with the updated configuration.
@github-actions github-actions Bot added the size: XL lines changed >1000 label Sep 26, 2026
@codecov

codecov Bot commented Sep 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.58%. Comparing base (e1fa91b) to head (7c511e6).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8381      +/-   ##
==========================================
- Coverage   99.59%   99.58%   -0.01%     
==========================================
  Files        1131     1131              
  Lines      103601   103601              
==========================================
- Hits       103179   103176       -3     
- Misses        422      425       +3     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mhucka
mhucka marked this pull request as ready for review September 26, 2026 03:37
@mhucka
mhucka marked this pull request as ready for review September 26, 2026 03:37
@mhucka
mhucka requested a review from a team as a code owner September 26, 2026 03:37
@mhucka
mhucka requested review from maffoo and mpharrigan September 26, 2026 03:37

@pavoljuhas pavoljuhas left a comment •

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Please restore hard error on line-too-long. I think it is more palatable to add local comment-overrides to make space for a very long URLs here and there. Otherwise there is no enforcement of the maximum line length as demonstrated by long lines added in this PR that got merrily accepted by yamllint CI.

Also, please make sure the original line breaks are preserved where possible for easier diffing and blaming of the content.

Comment thread docs/build/_index.yaml
Comment on lines +8 to +9
description: At the core of Cirq is the ability to construct quantum circuits. These are the methods
and data structures necessary to do so.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Nit - this is unnecessarily over 100 characters. It was also easier to read before with a new sentence starting on new line. Please just indent here.

Comment thread docs/noise/_index.yaml
Comment on lines +8 to +10
description: Running circuits on quantum hardware devices means dealing with the noise those devices
introduce to the computation. Cirq provides the following ways of managing that noise, to improve
the quality of the measured results.

@pavoljuhas pavoljuhas Sep 28, 2026 •

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Same as above, please just indent without reformatting line breaks.

Besides breaking the maximum line length this also introduces unnecessary diff which is not trivially suppressed by --ignore-all-space

There seem to be overall 20 lines with excessive line length, please address all instances flagged with yamllint -s . Please keep the original line breaks where possible.

Comment thread .yamllint.yaml
# IMPORTANT: if you change values here, update .editorconfig to match.

# Relaxed rules mean certain things like line lengths are warnings, not errors.
extends: relaxed

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Please restore the enforcement of maximum line lengths. As it is we got several unnecessarily long lines in this PR, all in text values that can be multi-line. The new CI setting did not flag them in the YAML lint check here. (The warnings are there, but require several clicks to expand).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size: XL lines changed >1000

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants