Skip to content

Use consistent formatting for CoreCLR repo link #4920

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 11, 2018
Merged

Use consistent formatting for CoreCLR repo link #4920

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8abb8e5
Use consistent formatting for CoreCLR repo link
ErlendLandro Apr 11, 2018
5ebaae3
Consistently format links to GitHub repositories
ErlendLandro Apr 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/core/build/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This article gives guidance to developers who want to build and distribute their

## Build the CLR from source

The source code for the .NET CoreCLR can be found in [the `dotnet/coreclr` repository on GitHub](https://github.com/dotnet/coreclr/).
The source code for the .NET CoreCLR can be found in [the CoreCLR repository on GitHub](https://github.com/dotnet/coreclr/).
Copy link
Contributor

@mairaw mairaw Apr 11, 2018

Choose a reason for hiding this comment

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

When we refer to repo names, we usually refer to them as the GitHub path. The sentence as it was tells users what it is: the .NET CoreCLR and where it is: dotnet/coreclr.

So for consistency, I'd keep it like that.

However, I think we can improve the readability of that sentence by making a change like this:
can be found in the [dotnet\coreclr](https://github.com/dotnet/coreclr/) repository on GitHub.

Copy link
Contributor Author

@ErlendLandro ErlendLandro Apr 11, 2018

Choose a reason for hiding this comment

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

That makes sense. I wanted to make it consistent with the link further down the page that looks like this:
at the base of [the CoreCLR repository](https://github.com/dotnet/coreclr/)

I'll make both of them the same format then: the [org-name/repo-name] repository

Copy link
Contributor

@mairaw mairaw Apr 11, 2018

Choose a reason for hiding this comment

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

Good catch @Mackiovello! Yes, that would be perfect!


The build currently depends on the following prerequisites:
* [Git](https://git-scm.com/)
Expand Down