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

Convert sipnet_inputs_outputs.doc to md #15

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

dlebauer
Copy link
Member

@dlebauer dlebauer commented Aug 8, 2024

Hopefully for easier reference.

Exported sipnet_inputs_outputs.doc from google docs to md, then cleaned up formatting and added TOC

@dlebauer dlebauer requested a review from Alomir August 8, 2024 22:20
Copy link
Contributor

@Alomir Alomir left a comment

Choose a reason for hiding this comment

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

I think a lot of the latex-style formatting is not working, due to misplaced $s? (That is, most everything in the rightmost column)

@Alomir
Copy link
Contributor

Alomir commented Aug 9, 2024

At least, I can't get it to look right in github (or vscode) - but I do notice that the equivalent formatting in this PR worked fine when exported to PDF.

… markdown, it was only being used for \times, \degree, and `^`
@dlebauer
Copy link
Member Author

dlebauer commented Aug 9, 2024

@Alomir it looks like a bug in GitHub's math processing. In the end I realized the latex formatting wasn't necessary at this point because 1) it was only being used for degrees, times, and superscripts and 2) these equations will eventually move to Doxygen.

FWIW, Github markddown does support math https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions. But it has some bugs / limitations, apparently including that it doesn't like using $^ for superscripts which on reflection is probably a misuse of the feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants