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

Devhub Issue: BC Government API Guidelines [Problems with underscores in web page display] #32

Open
annibalsilva opened this issue Jan 17, 2023 · 0 comments

Comments

@annibalsilva
Copy link

annibalsilva commented Jan 17, 2023

path: (do not delete) https://github.com/bcgov/api-guidelines/blob/master/government-of-british-columbia-api-guidelines.md
(do not delete) devhub page: https://developer.gov.bc.ca/Data-and-APIs/BC-Government-API-Guidelines

Devhub Content Issue

Some things aren't displayed correctly in the guidelines web page. The image below shows them:

Screenshot from 2023-01-17 17-42-00

  1. :heavyexclamationmark: is shown instead of ❗
  2. `perpage`_ is shown instead of per_page

Suggested solution

  1. Escape the underscores (:heavy\_excalamation\_mark:)
    1. Do not use italics there and everywhere else, if the code formatting can be deemed sufficient
    2. Italicize using asterisks (*`per_page`*)
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

No branches or pull requests

1 participant