Skip to content

Add xref links - #867

Merged
Colin Robertson (colin-home) merged 2 commits into
MicrosoftDocs:masterfrom
nxtn:patch-6
Mar 22, 2019
Merged

Colin Robertson (colin-home) merged 2 commits into
MicrosoftDocs:masterfrom
nxtn:patch-6

Conversation

@nxtn

Copy link
Copy Markdown
Contributor

No description provided.

@PRMerger20

Copy link
Copy Markdown
Contributor

Next Turn (@NextTurn) : Thanks for your contribution! The author, @, has been notified to review your proposed change.

@ktoliver

Copy link
Copy Markdown
Contributor

Hi @corob-msft - Could you review the proposed changes? Thanks.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Next Turn (@NextTurn) - Thanks for taking a look at this and adding a useful enhancement with the xrefs.

Unfortunately, there's a bit of a conflict in styles with the other changes here. While it hasn't been applied consistently across the repo, the formatting policy for language keywords is to use bold when they appear alone or in simple combinations like these, and only to use the inline code style when they appear as part of an expression. Function names have been very inconsistently formatted; we usually use inline code, except in the CRT documentation, where it's practically all bold. Because of some unfortunate CSS choices, the inline code formatting makes some of our pages look like they've been hit by a shotgun. It's not good.

Another policy that's being enforced by some tooling is to use a particular set phrase, "For more information, see [link friendly name](some-link-target)" when making a reference such as the compiler option link. This isn't worth revisiting lots of old topics for, but we'll update things if we're making changes in a topic anyway.

@Jak-MS

Copy link
Copy Markdown
Contributor

@corob-msft - can you provide specific guidance for this PR.

  • #sign-off if it's ready to merge
  • #hold-off if it requires changes before it's ready for sign off
  • #please-close - if these changes aren't going to be merged

Thanks!

@colin-home

Copy link
Copy Markdown
Contributor

Jak Koke (@Jak-MS) Isn't a review status of "requested changes" sufficiently indicative?

#hold-off

@Jak-MS

Copy link
Copy Markdown
Contributor

@corob-msft - thank you.

@PRMerger7

Copy link
Copy Markdown
Contributor

Next Turn (@NextTurn) : Thanks for your contribution! The author, @, has been notified to review your proposed change.

@nxtn

Copy link
Copy Markdown
Contributor Author

Thanks for clarification.

Pull the compiler option reference out of the table.
@PRMerger15

Copy link
Copy Markdown
Contributor

@corob-msft : Thanks for your contribution! The author, @, has been notified to review your proposed change.

@colin-home
Colin Robertson (colin-home) merged commit 371c2ef into MicrosoftDocs:master Mar 22, 2019
@nxtn
Next Turn (nxtn) deleted the patch-6 branch March 22, 2019 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants