Skip to content

Docs: add language declarations to code blocks

Amy Qualls requested to merge docs-aqualls-codeblocks-20200227 into master

What does this MR do?

This MR is yet another correction to the API pages, to add language declarations to the code blocks. Not complex work, but it helps make the list of remaining pages manageable.

Disclosure: buried amidst the mundane changes is one unrelated change. An API example contained someone's real name and real email address, and I altered them to dummy data.

Related issues

#32881 (closed)

Author's checklist

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports