Skip to content

Set default config :version #728

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

Closed
wants to merge 1 commit into from
Closed

Set default config :version #728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion lib/ex_doc.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ defmodule ExDoc do
:output => "./doc",
:retriever => ExDoc.Retriever,
:source_ref => "master",
:version => "dev",
}

@spec default(atom) :: term
Expand Down Expand Up @@ -45,7 +46,7 @@ defmodule ExDoc do
source_url: nil,
source_url_pattern: nil,
title: nil,
version: nil
version: @default.version
]

@type t :: %__MODULE__{
Expand Down
2 changes: 1 addition & 1 deletion lib/mix/tasks/docs.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ defmodule Mix.Tasks.Docs do
end

project = to_string(config[:name] || config[:app])
version = config[:version] || "dev"
version = config[:version] || ExDoc.Config.default(:version)
options =
config
|> get_docs_opts()
Expand Down
3 changes: 3 additions & 0 deletions test/ex_doc_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ defmodule ExDocTest do

assert Map.get(%ExDoc.Config{}, :source_ref) == "master"
assert ExDoc.Config.default(:source_ref) == "master"

assert Map.get(%ExDoc.Config{}, :version) == "dev"
assert ExDoc.Config.default(:version) == "dev"
end

test "version" do
Expand Down