Skip to content

Update writing-mathematical-expressions.md: Unsupported Math Blocks in <details> Blocks#23234

Closed
alernety wants to merge 3 commits into
github:mainfrom
alernety:patch-1
Closed

Update writing-mathematical-expressions.md: Unsupported Math Blocks in <details> Blocks#23234
alernety wants to merge 3 commits into
github:mainfrom
alernety:patch-1

Conversation

@alernety
Copy link
Copy Markdown

@alernety alernety commented Jan 16, 2023

This issue is about displaying math blocks inside of the details blocks (and potentially other HTML blocks) regardless of the type of math block. This can include blocks such as

$$
\begin{pmatrix}
  0 & 1 \\
  2 & 3
\end{pmatrix}
$$

or blocks written like this:

```math
\begin{pmatrix}
  0 & 1 \\
  2 & 3
\end{pmatrix}
```

This issue is currently blocking the use of math blocks inside of details blocks, as well as other HTML blocks. This limitation prevents users from taking full advantage of these blocks, and should be noted in documentation. To ensure users are not held back, we must actively search for a potential solution to this issue so that math blocks can be displayed in these blocks.

Why:

Closes ISSUE

What's being changed (if available, include any code snippets, screenshots, or gifs):

code
rendered

Check off the following:

  • I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • For content changes, I have completed the self-review checklist.

This issue is about displaying math blocks inside of the `details` blocks (and potentially other HTML blocks) regardless of the type of math block. This can include blocks such as 

```
$$
\begin{pmatrix}
  0 & 1 \\
  2 & 3
\end{pmatrix}
$$
```

or blocks written like this: 

~~~
```math
\begin{pmatrix}
  0 & 1 \\
  2 & 3
\end{pmatrix}
```
~~~

This issue is currently blocking the use of math blocks inside of `details` blocks, as well as other HTML blocks. This limitation prevents users from taking full advantage of these blocks, and should be noted in documentation. To ensure users are not held back, we must actively search for a potential solution to this issue so that math blocks can be displayed in these blocks.
@welcome
Copy link
Copy Markdown

welcome Bot commented Jan 16, 2023

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Jan 16, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 16, 2023

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md fpt
ghec
ghes@ 3.7 3.6
fpt
ghec
ghes@ 3.7 3.6

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

This change adds callouts to the document to ensure that it adheres to the [GitHub content style guide](https://github.com/github/docs/blob/main/contributing/content-style-guide.md).
@cmwilson21
Copy link
Copy Markdown
Contributor

@alernety Thanks so much for opening a PR! I'll get this triaged for review ⚡

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review get started Content related to "Getting Started" doc set and removed triage Do not begin working on this issue until triaged by the team labels Jan 17, 2023
@isaacmbrown
Copy link
Copy Markdown
Contributor

Hi @alernety, thanks for the PR! It appears to me that matrices render correctly IF you include a line of whitespace after the HTML tag.

For example,

<details>
<summary>Matrix</summary>

```math
\begin{pmatrix}
  0 & 1 \\
  2 & 3
\end{pmatrix}
```

</details>

Appears to render correctly:

Matrix $$\begin{pmatrix} 0 & 1 \\\ 2 & 3 \end{pmatrix}$$

I wonder if you could check whether this works for your use case too, and update your PR to reflect this if so? ✨

@isaacmbrown isaacmbrown added the more-information-needed More information is needed to complete review label Jan 31, 2023
@cmwilson21
Copy link
Copy Markdown
Contributor

It doesn't look like any updates have been on this for a while, so I'm going to go ahead and close it out 💛

Feel free to ping me here to reopen if it continues to be an issue.

@cmwilson21 cmwilson21 closed this Sep 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set more-information-needed More information is needed to complete review waiting for review Issue/PR is waiting for a writer's review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants