Skip to content
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.

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

Misc doc changes #41

Merged
merged 2 commits into from
Feb 25, 2021
Merged

Conversation

kianmeng
Copy link
Contributor

@kianmeng kianmeng commented Feb 17, 2021

Refs #38

Besides other fixes, this commit ensures the generated HTML
documentation for HexDocs.pm will become the main documentation
source for this Elixir library.

List of changes:

  • Update gitignore
  • Update copyright year
  • Set and use latest ex_doc
  • Set readme as main HTML doc
  • Fix markdown
  • Badges and more badges!
  • Fix license link
  • Add source reference by tagged version

Screenshot:

Screenshot-20210217222033-2740x1462

Besides other fixes, this commit ensures the generated HTML
documentation for HexDocs.pm will become the main documentation
source for this Elixir library.

List of changes:
* Update gitignore
* Update copyright year
* Set and use latest ex_doc
* Set readme as main HTML doc
* Fix markdown
* Badges and more badges!
* Fix license link
* Add source reference by tagged version
Copy link
Member

@szymon-jez szymon-jez left a comment

Choose a reason for hiding this comment

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

Looking good

README.md Outdated Show resolved Hide resolved
Comment on lines 30 to +34
{:sweet_xml, "~> 0.6.5"},
{:ex_doc, "~> 0.18.0", only: :dev, runtime: false},
{:credo, "~> 1.0.0", only: [:dev, :test], runtime: false},
{:ex_doc, ">= 0.0.0", only: :dev, runtime: false},
{:ex_spec, "~> 2.0", only: :test},
{:excoveralls, "~> 0.10", only: :test},
{:credo, "~> 1.0.0", only: [:dev, :test], runtime: false}
{:excoveralls, "~> 0.10", only: :test}
Copy link
Member

Choose a reason for hiding this comment

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

The changes look like done to order the list alphabetically, but they are not as sweet_xml is out of order. Either let's put sweet_xml last to have alphabetical order or revert this change.

@szymon-jez szymon-jez requested a review from tomekowal February 22, 2021 11:08
Co-authored-by: Szymon Jeż <[email protected]>
@tomekowal
Copy link
Contributor

Thank you @kianmeng for your input ❤️

@szymon-jez szymon-jez merged commit 9ce6b20 into ex-phone-number:develop Feb 25, 2021
@szymon-jez
Copy link
Member

@kianmeng Thank you very much. Merged.

szymon-jez pushed a commit that referenced this pull request Mar 6, 2023
Signed-off-by: Szymon Jeż <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants