Skip to content

GO API Docs on wiki have non-standard quote characters #2532

Description

@batpad

In the API Docs on the wiki, for example here: https://go-wiki.ifrc.org/en/go-api/Connecting_to_GO_API#:~:text=Then%20enter%20%7B%22username%22%3A%20%E2%80%9Cyour%2Dusername%E2%80%9D%2C%20%22password%22%3A%20%E2%80%9Cyour%2Dpassword%E2%80%9D%7D.%20In%20the%20field%20%E2%80%9Cyour%2Dusername%E2%80%9D

The docs have in the example:

{"username": “your-username”, "password": “your-password”}

The quote characters there around your-username and your-password are not standard ASCII quote characters and will give errors if someone copy / pastes the example and edits it. (i.e. they have “ instead of "). We should fix all quote characters in the wiki docs to be standard ASCII so they are pasteable and don't cause hard-to-track-down errors for people trying to copy-paste examples.

This is a bit silly, and easy mistake to make when copy-pasting things around - the biggest culprit for me is always MS Word that insists on converting standard " characters to fancy “ characters.

This was a great catch by @wrynearson .

Don't think there's any urgency, but would be good to fix at some point.

cc @tovari @szabozoltan69

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions