search

opengeospatial / ogcapi-environmental-data-retrieval

A Web API that provides a family of lightweight interfaces for accessing Environmental Data resources.
https://ogcapi.ogc.org/edr
Other
59 stars 26 forks source link

Test text: parameters in text be quoted with back-ticks #91

Closed chris-little closed 4 years ago

chris-little commented 4 years ago

Should parameters, like resolutionx be enclosed in back-ticks/grave accents throughout the document?

chris-little commented 4 years ago

As parameters etc are snippets of code, it is good GitHub practice to enclose in backticks (grave accents, to left of '1' on English MS Windows Keyboard. It also avoids invoking GitHub 'magic' behaviour when special characters like # and @ are used. I have already annoyed someone called KR, who cannot speak Korean, when using language tags @kr.

dr-shorthair commented 4 years ago

Mind you, if you grab a standard language tag as your moniker, then you probably should expect (and tolerate) some consequences. I deleted his/her rant from the github issue thread because its length overwhelmed the actual issue topic.

chris-little commented 4 years ago

@dr-shorthair You are lucky that the Dominican Republic went for @do !

chris-little commented 4 years ago

As agreed at the EDR API SWG on 2020-07-09, Pull Request now being constructed with reordered chapters and all instances of code delimited by back ticks.