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

Fix doc rendering issue #81

Merged
merged 1 commit into from
Nov 25, 2022
Merged

Fix doc rendering issue #81

merged 1 commit into from
Nov 25, 2022

Conversation

tohrnii
Copy link
Contributor

@tohrnii tohrnii commented Nov 23, 2022

Addressing #78.

Copy link
Contributor

@grjte grjte left a comment

Choose a reason for hiding this comment

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

This fixes look good to me! However, the mdbook only deploys from main. We should probably do one of the following:

  1. keep docs in sync with next, and change the CI book.yml workflow to deploy when the next branch is updated
  2. merge this to main instead and then rebase next

I think this project is young enough and fast-moving enough that I'd probably go for the first option. What do you think?

@tohrnii tohrnii force-pushed the tohrnii-formatting-issue branch from 4c6efb8 to 473bdc6 Compare November 25, 2022 11:32
@tohrnii
Copy link
Contributor Author

tohrnii commented Nov 25, 2022

@grjte Agreed! I made the change to book.yml.

@Al-Kindi-0
Copy link
Collaborator

Al-Kindi-0 commented Nov 25, 2022

Thank you @tohrnii !
A couple of questions:

  1. Is \$rand the correct syntax or is it $rand and \$ is just for .md formatting?
  2. Does this address the issue in the example in section 2.5?

@tohrnii
Copy link
Contributor Author

tohrnii commented Nov 25, 2022

@Al-Kindi-0 To answer your questions:

  1. It's just for .md formatting. The correct syntax in AirScript is without the back slash.
  2. The fix for that was included in Remove duplicate examples and only keep one example from docs in the examples directory #74 however it may not be getting reflected right now since the change was made to next branch but the docs are being pulled from main branch. That has been fixed in this PR so should be fixed after this PR is merged.

@Al-Kindi-0
Copy link
Collaborator

Thank you!
In line 91, should that be "last row" instead?

@tohrnii tohrnii force-pushed the tohrnii-formatting-issue branch from 473bdc6 to 642fb60 Compare November 25, 2022 12:27
@tohrnii
Copy link
Contributor Author

tohrnii commented Nov 25, 2022

@Al-Kindi-0 Thank you. Fixed.

Copy link
Contributor

@grjte grjte left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks!

@tohrnii tohrnii merged commit d522c69 into next Nov 25, 2022
@tohrnii tohrnii deleted the tohrnii-formatting-issue branch November 25, 2022 14:29
@grjte grjte mentioned this pull request Nov 29, 2022
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.

3 participants