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

Finalize version 1.0.0 #174

Merged
merged 5 commits into from
Jan 14, 2023
Merged

Finalize version 1.0.0 #174

merged 5 commits into from
Jan 14, 2023

Conversation

pbodnar
Copy link
Collaborator

@pbodnar pbodnar commented Jan 7, 2023

These should be the final changes before releasing the next version of mistletoe - this time we should feel already confident enough to name it 1.0.0.

And this a preview of the release notes:


WARNING - Backwards compatibility changes:

  • Contrib folder update #167: For practical reasons and for following common packaging practices, contrib folder got moved under the mistletoe folder / package. So if you reference a renderer from that folder, you need to reference it as mistletoe.contrib.<renderer> now.
  • See "change handling of (white)space characters in code spans" below. We keep processing extra whitespace characters at the parsing level, so that all renderers can benefit from it out-of-the-box. Provided that a custom renderer, for whatever reason, relied on all the spaces being collapsed, it needs to do that collapsing itself now (e.g. ' '.join(re.split('[ \n]+', content.strip())), or re.sub('[ \n]+', ' ', content.strip())).

Added:

Fixed:

Updated:


* 3.3 and 3.4 removed as we have `python_requires='~=3.5'` already
* add newer versions of Python (with 3.11 just tested locally)
Although we don't use Travis currently, let's make its setup up-to-date:

* add newer versions of Python (with 3.11 just tested locally)
* remove the strange `matrix.include.*` properties comming from e9c537b, as:
  1) according to the docs, there should be probably "jobs" instead of "matrix"
  2) the goal of this section is unclear
... as the project is already widely used and it seems stable enough already.
@pbodnar
Copy link
Collaborator Author

pbodnar commented Jan 7, 2023

@anderskaplan or other great contributors, here's an opportunity to give some final feedback before I release and publish mistletoe 1.0.0 in a few days. I hope I have prepared all well, yet I could have overlooked something. So thanks in advance for your prospective review. :)

@pbodnar
Copy link
Collaborator Author

pbodnar commented Jan 7, 2023

PS: For future releases, I plan to use the GitHub's Milestones feature, so that it is more visible, even in advance, which issue or pull request goes to which version.

@anderskaplan
Copy link
Contributor

Looks good to me!

@pbodnar pbodnar merged commit 35f961c into master Jan 14, 2023
@pbodnar pbodnar deleted the finalize-version-1 branch January 14, 2023 20:22
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