Documentation improvements for remotes keyword

[mortenpi]

• The makedocs docstring should make it clear that it needs to be a Dict (not a Vector{Pair}).
• The commit value must be a string and should be any Git ref (doesn't have to be a commit, can also be a version tag).
• We should add a helpful error message if the user passes a VersionNumber as commit (saying to convert to string first).
• We should add docs examples for both Pkg.develop case (can determine commit automatically), and Pkg.add case (user needs to supply the version tag).

cc @baggepinnen

[odow]

We should add docs examples for both Pkg.develop case (can determine commit automatically), and Pkg.add case (user needs to supply the version tag).

How does one do this? jump-dev/JuMP.jl#3526

[mortenpi]

You pass a tuple instead, i.e. path::String => (remote::Remote, commit::String).

Documenter.jl/src/documents.jl

Lines 506 to 507 in e50da5d

	remote = if remoteref isa Tuple{Remotes.Remote, AbstractString}
	RemoteRepository(path, remoteref[1], remoteref[2])

[odow]

You pass a tuple instead

Aaaaaah. I missed this part. I was looking in the Remotes module.