Skip to content

Commit

Permalink
Updated the docs, ex_doc, mix.exs, and the changelog for 0.7.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Shakadak committed Apr 11, 2022
1 parent ee52bbf commit 60c328d
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 14 deletions.
9 changes: 6 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@

## [Unreleased]

## [0.7.3] (2022-04-11)

### Changed

* Handling the option `{:rules, _}` ourselve, as well as partially the option `{:rules, _, _, _}`.
When nothing is given, a new table is created, and destroyed after.
If a table is given, and a DTD option is chosen, the table is reused for the DTD handling.
If a custom `{:rules, _, _, _}` is given, and a restrictive DTD option is chosen, the custome rule will be overriden.
Because of this mutual exclusivity (reconciling the behaviors is not possible via composition), it is recommended that you handle the DTD
problem by yourself. You can see the issue #71 for ideas.
See the issue #41 for more details on why this change happened. (Ets leaks.)
problem by yourself. You can see the issue `#71` for ideas.
See the issue `#41` for more details on why this change happened. (Ets leaks.)

## [0.7.2] (2021-11-25)

Expand Down Expand Up @@ -109,8 +111,9 @@

Changelog format inspired by [keep-a-changelog](https://github.com/olivierlacan/keep-a-changelog)

[unreleased]: https://github.com/kbrw/sweet_xml/compare/v0.7.2...HEAD
[unreleased]: https://github.com/kbrw/sweet_xml/compare/v0.7.3...HEAD

[0.7.3]: https://github.com/kbrw/sweet_xml/compare/v0.7.2...v0.7.3
[0.7.2]: https://github.com/kbrw/sweet_xml/compare/v0.7.1...v0.7.2
[0.7.1]: https://github.com/kbrw/sweet_xml/compare/v0.7.0...v0.7.1
[0.7.0]: https://github.com/kbrw/sweet_xml/compare/0.6.6...v0.7.0
Expand Down
4 changes: 4 additions & 0 deletions lib/sweet_xml.ex
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,8 @@ defmodule SweetXml do
end

@doc """
> #### Soft Deprecation {: .warning}
>
> Will be later deprecated in favor of `stream_tags!/3`.
Most common usage of streaming: stream a given tag or a list of tags, and
Expand Down Expand Up @@ -422,6 +424,8 @@ defmodule SweetXml do
end

@doc """
> #### Soft Deprecation {: .warning}
>
> Will be later deprecated in favor of `stream!/2`.
Create an element stream from a XML `doc`.
Expand Down
14 changes: 8 additions & 6 deletions mix.exs
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
defmodule SweetXml.Mixfile do
use Mix.Project

def version, do: "0.7.2"
def version, do: "0.7.3"

@source_url "https://github.com/kbrw/sweet_xml"
def app, do: :sweet_xml

def source_url, do: "https://github.com/kbrw/#{app()}"

def project do
[
app: :sweet_xml,
app: app(),
version: version(),
elixir: "~> 1.0",
description: "A sweet wrapper of :xmerl to help query XML docs",
Expand Down Expand Up @@ -36,7 +38,7 @@ defmodule SweetXml.Mixfile do
"README.md": [title: "Overview"]
],
main: "readme",
source_url: @source_url,
source_url: source_url(),
# We need to git tag with the corresponding format.
source_ref: "v#{version()}",
]
Expand All @@ -53,8 +55,8 @@ defmodule SweetXml.Mixfile do
],
licenses: ["MIT"],
links: %{
"Changelog" => "https://hexdocs.pm/sweet_xml/changelog.html",
"GitHub" => @source_url
"Changelog" => "https://hexdocs.pm/#{app()}/changelog.html",
"GitHub" => source_url(),
}
]
end
Expand Down
10 changes: 5 additions & 5 deletions mix.lock
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
%{
"earmark": {:hex, :earmark, "1.3.1", "73812f447f7a42358d3ba79283cfa3075a7580a3a2ed457616d6517ac3738cb9", [:mix], [], "hexpm", "000aaeff08919e95e7aea13e4af7b2b9734577b3e6a7c50ee31ee88cab6ec4fb"},
"earmark_parser": {:hex, :earmark_parser, "1.4.12", "b245e875ec0a311a342320da0551da407d9d2b65d98f7a9597ae078615af3449", [:mix], [], "hexpm", "711e2cc4d64abb7d566d43f54b78f7dc129308a63bc103fbd88550d2174b3160"},
"ex_doc": {:hex, :ex_doc, "0.24.1", "15673de99154f93ca7f05900e4e4155ced1ee0cd34e0caeee567900a616871a4", [:mix], [{:earmark_parser, "~> 1.4.0", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "07972f17bdf7dc7b5bd76ec97b556b26178ed3f056e7ec9288eb7cea7f91cce2"},
"makeup": {:hex, :makeup, "1.0.5", "d5a830bc42c9800ce07dd97fa94669dfb93d3bf5fcf6ea7a0c67b2e0e4a7f26c", [:mix], [{:nimble_parsec, "~> 0.5 or ~> 1.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "cfa158c02d3f5c0c665d0af11512fed3fba0144cf1aadee0f2ce17747fba2ca9"},
"makeup_elixir": {:hex, :makeup_elixir, "0.15.1", "b5888c880d17d1cc3e598f05cdb5b5a91b7b17ac4eaf5f297cb697663a1094dd", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.1", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "db68c173234b07ab2a07f645a5acdc117b9f99d69ebf521821d89690ae6c6ec8"},
"earmark_parser": {:hex, :earmark_parser, "1.4.25", "2024618731c55ebfcc5439d756852ec4e85978a39d0d58593763924d9a15916f", [:mix], [], "hexpm", "56749c5e1c59447f7b7a23ddb235e4b3defe276afc220a6227237f3efe83f51e"},
"ex_doc": {:hex, :ex_doc, "0.28.3", "6eea2f69995f5fba94cd6dd398df369fe4e777a47cd887714a0976930615c9e6", [:mix], [{:earmark_parser, "~> 1.4.19", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "05387a6a2655b5f9820f3f627450ed20b4325c25977b2ee69bed90af6688e718"},
"makeup": {:hex, :makeup, "1.1.0", "6b67c8bc2882a6b6a445859952a602afc1a41c2e08379ca057c0f525366fc3ca", [:mix], [{:nimble_parsec, "~> 1.2.2 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "0a45ed501f4a8897f580eabf99a2e5234ea3e75a4373c8a52824f6e873be57a6"},
"makeup_elixir": {:hex, :makeup_elixir, "0.16.0", "f8c570a0d33f8039513fbccaf7108c5d750f47d8defd44088371191b76492b0b", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "28b2cbdc13960a46ae9a8858c4bebdec3c9a6d7b4b9e7f4ed1502f8159f338e7"},
"makeup_erlang": {:hex, :makeup_erlang, "0.1.1", "3fcb7f09eb9d98dc4d208f49cc955a34218fc41ff6b84df7c75b3e6e533cc65f", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "174d0809e98a4ef0b3309256cbf97101c6ec01c4ab0b23e926a9e17df2077cbb"},
"markdown": {:git, "git://github.com/devinus/markdown.git", "cd0df79b6f1cc374499d47f6ba6aaab5096f874f", []},
"nimble_parsec": {:hex, :nimble_parsec, "1.1.0", "3a6fca1550363552e54c216debb6a9e95bd8d32348938e13de5eda962c0d7f89", [:mix], [], "hexpm", "08eb32d66b706e913ff748f11694b17981c0b04a33ef470e33e11b3d3ac8f54b"},
"nimble_parsec": {:hex, :nimble_parsec, "1.2.3", "244836e6e3f1200c7f30cb56733fd808744eca61fd182f731eac4af635cc6d0b", [:mix], [], "hexpm", "c8d789e39b9131acf7b99291e93dae60ab48ef14a7ee9d58c6964f59efb570b0"},
}

0 comments on commit 60c328d

Please sign in to comment.