Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(weave): Remove #highlight-next-line to fix indentation issue #3021

Merged
merged 3 commits into from
Nov 21, 2024

Conversation

J2-D2-3PO
Copy link
Contributor

@J2-D2-3PO J2-D2-3PO commented Nov 19, 2024

Description

Fixes indentation issue in code sample by removing the magic comment #highlight-next-line in the Python code sample on L197 of weave/docs/docs/guides/tracking/tracing.mdx. See https://weightsandbiases.slack.com/archives/C01DX8LRZEJ/p1732038958244399?thread_ts=1732032632.859409&cid=C01DX8LRZEJ for context

The long term fix here would be to fiddle with the CSS. However, this at least prevents the issue on this page.

Testing

  1. Viewed in prod docs and confirmed indentation issue was present
  2. Viewed in local docs and confirmed that no indentation issue was present.
  3. Inspected HTML on both local and prod, confirmed that prod HTML has CSS class #theme-code-block-highlighted-line that appears to be indenting the block
  4. Confirmed that removing magic comment #highlight-next-line removes CSS class

@J2-D2-3PO J2-D2-3PO requested a review from a team as a code owner November 19, 2024 19:11
@J2-D2-3PO J2-D2-3PO changed the title Remove #highlight-next-line to fix indentation issue chore(docs): Remove #highlight-next-line to fix indentation issue Nov 19, 2024
@circle-job-mirror
Copy link

circle-job-mirror bot commented Nov 19, 2024

@J2-D2-3PO J2-D2-3PO changed the title chore(docs): Remove #highlight-next-line to fix indentation issue docs(weave): Remove #highlight-next-line to fix indentation issue Nov 19, 2024
@J2-D2-3PO J2-D2-3PO merged commit a323429 into master Nov 21, 2024
115 checks passed
@J2-D2-3PO J2-D2-3PO deleted the DOCS-1049 branch November 21, 2024 18:55
@github-actions github-actions bot locked and limited conversation to collaborators Nov 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants