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.

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

Jump to bottom

Misc doc changes #188

Merged
merged 1 commit into from Mar 16, 2021
Merged

Misc doc changes #188

merged 1 commit into from Mar 16, 2021

Conversation

kianmeng
Copy link
Contributor

List of changes:

  • Fix typos
  • Set preferred cli env for mix docs
  • Use common source url
  • Add changelog link to hex info page
  • Use and set ex_doc to latest version
  • Fix markdowns
  • Update http to https
  • Badges and more badges!
  • Add license section

ono
ono reviewed Feb 24, 2021
View reviewed changes
Copy link
Collaborator

@ono ono left a comment

Choose a reason for hiding this comment

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

looking great 😍 😍 😍

the changes will be merged once bulleted list formatting is updated as commented. thank you!

README.md Outdated Show resolved Hide resolved
lib/amqp/application.ex Outdated Show resolved Hide resolved
@kianmeng kianmeng requested a review from ono March 2, 2021 15:22
@ono
Copy link
Collaborator

ono commented Mar 3, 2021

thank you. i noticed the latest commit also include 80 chars per line format which was not in the original proposal. i don't want to debate but i am not a big fan of that so would like to keep the current way... sorry about the hassle but could you keep the linefeeds as they are? 🙇‍♂️

@kianmeng
Copy link
Contributor Author

kianmeng commented Mar 7, 2021

thank you. i noticed the latest commit also include 80 chars per line format which was not in the original proposal. i don't want to debate but i am not a big fan of that so would like to keep the current way... sorry about the hassle but could you keep the linefeeds as they are?

@ono No worry. 😄
Do you have a standard number of characters per line in mind? I've noticed the source code have a mix of 80+ till 130+ characters per line? Perhaps we can set a standard characters per line for this library? We can set in .formatter.exs or add .editorconfig file and then format the line length to a new standard length.

Let me know.

@ono
Copy link
Collaborator

ono commented Mar 8, 2021

hey @kianmeng. i was a bit overwhelmed by a diff view but i think it doesn't look bad when i see the changes in the file. I also checked other popular Elixir library and majority of them put linefeed to docs too. I would like to go with the changes. I think we can stay with the default value for formatter.exs so no change needed on this.

can you resolve the conflicts? then i will merge this. thanks!

@kianmeng
Misc doc generation changes
836060f 
List of changes:
* Fix typos
* Set preferred cli env for mix docs
* Use common source url
* Add changelog link to hex info page
* Use and set ex_doc to latest version
* Fix markdowns
* Update http to https
* Badges and more badges!
* Add license section
* Set output to html only
@kianmeng
Copy link
Contributor Author

can you resolve the conflicts? then i will merge this. thanks!

@ono Done. Please check and let me know. 😄

@ono ono merged commit 6bbfdbf into pma:main Mar 16, 2021
@ono
Copy link
Collaborator

ono commented Mar 16, 2021

merged 🎉 thank you very much @kianmeng!

This was referenced Mar 17, 2021
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ono ono Awaiting requested review from ono

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@kianmeng @ono