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 formatting errors in user guide #1479

Merged
merged 1 commit into from
Feb 13, 2021

Conversation

ang-zeyu
Copy link
Contributor

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • Others, please explain:

Some of the tags / newlines in the user guide don't observe markdown rules following the implicit fixes in #1403 , and elsewhere

Causing things like this:
Untitled

Overview of changes:

  • change some inline tags to 'block' markdown tags and vice versa
    • changes to inline tags are due to the parent tag not being able to hold 'block' tags
    • changes to block tags (just one) as the parent tag should be able to hold other 'block' tags
  • remove some newlines

so everything renders properly

Anything you'd like to highlight / discuss:

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)
Fix formatting errors in user guide


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No blatantly unrelated changes
  • Pinged someone for a review!

@ang-zeyu
Copy link
Contributor Author

@ryoarmanda fyi, fixing these collated issues as it would affect reviews in #1478, do rebase / merge on top once done!

@ang-zeyu ang-zeyu added this to the v3.0 milestone Feb 13, 2021
@ang-zeyu ang-zeyu merged commit 48280e4 into MarkBind:master Feb 13, 2021
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.

1 participant