Skip to content

Changelog: improve Changelog & convert to Markdown #230

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

Merged
merged 1 commit into from
Mar 9, 2017
Merged

Changelog: improve Changelog & convert to Markdown #230

merged 1 commit into from
Mar 9, 2017

Conversation

GhostLyrics
Copy link
Contributor

I hope that you like what I did to the Changelog and are not offended I chose not to use RST for this, but the comparison links didn't seem well suited for what I could find about RST's link syntax.

  • rename to ChangeLog.markdown
  • add release dates
  • add comparison links

Fixes #229

@gpocentek
Copy link
Contributor

Thank you, this is a great improvement! A few comments:

  • Could you switch to RST? Everything else is RST, and it would allow us to add the changelog in the docs
  • Could you also amend you commit to fix the pep8 issue? Make the short commit message shorter, and add information in the commit message body.

Thanks!

@GhostLyrics
Copy link
Contributor Author

Can you use variables for links in Rest like I used for the changes? See the bottom of the file. All this would need to be inline unless I overlooked something.

@gpocentek
Copy link
Contributor

Yes, you can use something like:

Version 0.19_:
 * blah blah blah
.. _0.19: http://whatever.com

http://docutils.sourceforge.net/docs/user/rst/quickref.html#hyperlink-targets

@GhostLyrics
Copy link
Contributor Author

Will try to do this today.

+ change indentation so bullet points are not treated as quote
+ add links to releases
+ add dates to releases
+ use releases as headers
@GhostLyrics
Copy link
Contributor Author

It's done and the tests pass :)

@gpocentek
Copy link
Contributor

Looks good, thank you!

@gpocentek gpocentek merged commit 37ee7ea into python-gitlab:master Mar 9, 2017
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.

2 participants