Skip to content

Standardize formatting of 'S'#54

Merged
Luis-Varona merged 1 commit intomainfrom
general-docs-updates
Aug 13, 2025
Merged

Standardize formatting of 'S'#54
Luis-Varona merged 1 commit intomainfrom
general-docs-updates

Conversation

@Luis-Varona
Copy link
Member

This PR standardizes the formatting of 'S' in docstrings, surrounding it with double backticks every time unless it is in reference to a parameter (in which case single backticks are used).

It also fleshes out the docstring for the '_assert_graph_has_defined_s_bandwidth' method in utils, although that is not yet complete.

This PR standardizes the formatting of 'S' in docstrings, surrounding it with double backticks every time unless it is in reference to a parameter (in which case single backticks are used).

It also fleshes out the docstring for the '_assert_graph_has_defined_s_bandwidth' method in utils, although that is not yet complete.
@Luis-Varona Luis-Varona self-assigned this Aug 13, 2025
@Luis-Varona Luis-Varona added the documentation Improvements or additions to documentation label Aug 13, 2025
@Luis-Varona Luis-Varona merged commit 1668ba7 into main Aug 13, 2025
8 checks passed
@Luis-Varona Luis-Varona deleted the general-docs-updates branch August 13, 2025 17:34
@codecov
Copy link

codecov bot commented Aug 13, 2025

Codecov Report

❌ Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/utils.jl 0.00% 1 Missing ⚠️

📢 Thoughts on this report? Let us know!

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant