From d0e674852c5514017f40e3d9311de3be6256e70d Mon Sep 17 00:00:00 2001 From: Jon Parise Date: Wed, 14 Sep 2016 17:31:34 -0700 Subject: [PATCH] Improve the top-level Thrift module docs Also, update our ex_doc and earmark dependencies. --- lib/thrift.ex | 9 ++++++++- mix.exs | 4 ++-- mix.lock | 4 ++-- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/lib/thrift.ex b/lib/thrift.ex index eab0062a..08f2afca 100644 --- a/lib/thrift.ex +++ b/lib/thrift.ex @@ -1,3 +1,10 @@ defmodule Thrift do - @moduledoc "Thrift contains Elixir utilities for working with Thrift" + @moduledoc ~S""" + Thrift provides [Apache Thrift](http://thrift.apache.org/) support: + + * `Mix.Tasks.Compile.Thrift` - mix task for generate Erlang source files + from `.thrift` schema files + + * `Thrift.Parser` - functions for parsing `.thift` schema files + """ end diff --git a/mix.exs b/mix.exs index 06c05126..80d01229 100644 --- a/mix.exs +++ b/mix.exs @@ -38,8 +38,8 @@ defmodule Thrift.Mixfile do end defp deps do - [{:ex_doc, "~> 0.12.0", only: :dev}, - {:earmark, "~> 0.2.1", only: :dev}, + [{:ex_doc, "~> 0.13.1", only: :dev}, + {:earmark, "~> 1.0", only: :dev}, {:excoveralls, "~> 0.5.4", only: :test}, {:credo, "~> 0.4.11", only: [:dev, :test]}, {:dialyze, "~> 0.2.0", only: [:dev, :test]} diff --git a/mix.lock b/mix.lock index 1cd0be05..f6c929e2 100644 --- a/mix.lock +++ b/mix.lock @@ -2,8 +2,8 @@ "certifi": {:hex, :certifi, "0.4.0", "a7966efb868b179023618d29a407548f70c52466bf1849b9e8ebd0e34b7ea11f", [:rebar3], []}, "credo": {:hex, :credo, "0.4.11", "03a64e9d53309b7132556284dda0be57ba1013885725124cfea7748d740c6170", [:mix], [{:bunt, "~> 0.1.6", [hex: :bunt, optional: false]}]}, "dialyze": {:hex, :dialyze, "0.2.1", "9fb71767f96649020d769db7cbd7290059daff23707d6e851e206b1fdfa92f9d", [:mix], []}, - "earmark": {:hex, :earmark, "0.2.1", "ba6d26ceb16106d069b289df66751734802777a3cbb6787026dd800ffeb850f3", [:mix], []}, - "ex_doc": {:hex, :ex_doc, "0.12.0", "b774aabfede4af31c0301aece12371cbd25995a21bb3d71d66f5c2fe074c603f", [:mix], [{:earmark, "~> 0.2", [hex: :earmark, optional: false]}]}, + "earmark": {:hex, :earmark, "1.0.1", "2c2cd903bfdc3de3f189bd9a8d4569a075b88a8981ded9a0d95672f6e2b63141", [:mix], []}, + "ex_doc": {:hex, :ex_doc, "0.13.1", "658dbfc8cc5b0fac192f0f3254efe66ee6294200804a291549e0aeb052053bba", [:mix], [{:earmark, "~> 1.0", [hex: :earmark, optional: false]}]}, "excoveralls": {:hex, :excoveralls, "0.5.4", "1a6e116bcf980da8b7fe33140c1d7e61aa0a4e51951cadbfacc420c12d2b9b8f", [:mix], [{:exjsx, "~> 3.0", [hex: :exjsx, optional: false]}, {:hackney, ">= 0.12.0", [hex: :hackney, optional: false]}]}, "exjsx": {:hex, :exjsx, "3.2.0", "7136cc739ace295fc74c378f33699e5145bead4fdc1b4799822d0287489136fb", [:mix], [{:jsx, "~> 2.6.2", [hex: :jsx, optional: false]}]}, "hackney": {:hex, :hackney, "1.6.0", "8d1e9440c9edf23bf5e5e2fe0c71de03eb265103b72901337394c840eec679ac", [:rebar3], [{:certifi, "0.4.0", [hex: :certifi, optional: false]}, {:idna, "1.2.0", [hex: :idna, optional: false]}, {:metrics, "1.0.1", [hex: :metrics, optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, optional: false]}, {:ssl_verify_fun, "1.1.0", [hex: :ssl_verify_fun, optional: false]}]},