✨ NEW: Add simple typographic replacements #59

tsutsu3 · 2020-10-19T18:40:04Z

Issue

Summary

Implemented replacements (Simple typographic replacements) rule.

Change

Added a test to make sure that even a single capital letter is matched correctly.

welcome · 2020-10-19T18:40:05Z

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.

Welcome to the EBP community! 🎉

chrisjsewell

Awesome thanks! Just a minor nitpick

chrisjsewell · 2020-10-19T19:03:51Z

markdown_it/rules_core/replacements.py

+# - fractionals 1/2, 1/4, 3/4 -> ½, ¼, ¾
+# - miltiplication 2 x 4 -> 2 × 4
+
+RARE_RE = r"\+-|\.\.|\?\?\?\?|!!!!|,,|--"


Suggested change

RARE_RE = r"\+-|\.\.|\?\?\?\?|!!!!|,,|--"

RARE_RE = re.compile(r"\+-|\.\.|\?\?\?\?|!!!!|,,|--")

It's a bit more performant to pre-compile, then use e.g. RARE_RE.search

chrisjsewell · 2020-10-19T19:06:33Z

markdown_it/rules_core/replacements.py

+# or root check will fail every second time
+# SCOPED_ABBR_TEST_RE = r"\((c|tm|r|p)\)"
+
+SCOPED_ABBR_RE = r"\((c|tm|r|p)\)"


Suggested change

SCOPED_ABBR_RE = r"\((c|tm|r|p)\)"

SCOPED_ABBR_RE = re.compile(r"\((c|tm|r|p)\)", flags=re.IGNORECASE)

same as above

chrisjsewell · 2020-10-19T19:11:16Z

Also you can just pip install pre-commit, then pre-commit run -all to correctly format

chrisjsewell · 2020-10-19T19:12:07Z

markdown_it/rules_core/replacements.py

+"""
+import logging
+import re
+from typing import List


Suggested change

from typing import List

from typing import List, Match

Thank you.

I was just in trouble. 😄

chrisjsewell · 2020-10-19T19:12:31Z

markdown_it/rules_core/replacements.py

+}
+
+
+def replaceFn(match: re.Match):


Suggested change

def replaceFn(match: re.Match):

def replaceFn(match: Match):

codecov · 2020-10-20T06:38:40Z

Codecov Report

Merging #59 into master will decrease coverage by 0.06%.
The diff coverage is 91.22%.

@@            Coverage Diff             @@
##           master      #59      +/-   ##
==========================================
- Coverage   95.37%   95.31%   -0.07%     
==========================================
  Files          73       74       +1     
  Lines        3571     3627      +56     
==========================================
+ Hits         3406     3457      +51     
- Misses        165      170       +5

Flag	Coverage Δ
#pytests	`95.31% <91.22%> (-0.07%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
markdown_it/rules_core/replacements.py	`90.90% <90.90%> (ø)`
markdown_it/parser_core.py	`100.00% <100.00%> (ø)`
markdown_it/rules_core/__init__.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c8f82bc...4308e3f. Read the comment docs.

tsutsu3 · 2020-10-20T09:36:19Z

If I add this line to conf.py:

nitpick_ignore = [("py:class", "Match")]

sphinx warning goes away, is it ok to add it?

How can I get rid of the warning?

chrisjsewell · 2020-10-20T09:39:23Z

sphinx warning goes away, is it ok to add it?

yep thats absolutely fine, I don't think there is another "fix"

tsutsu3 · 2020-10-20T10:45:06Z

I added nitpick_ignore = [("py:class", "Match")] in conf.py.

With python 3.7 there is no warning, but with python 3.6 the warning is still there.

/home/circleci/.local/lib/python3.6/site-packages/markdown_it/rules_core/replacements.py:docstring of markdown_it.rules_core.replacements.replaceFn:: WARNING: py:class reference target not found: Match[~ AnyStr]
generating indices...  genindex py-modindexdone

Hmm..., it's going to take some time to fix... 🤔 😕

chrisjsewell · 2020-10-20T23:58:27Z

looking good to me 👍 Is it ready for review?

tsutsu3 · 2020-10-21T00:10:33Z

Should I put together a commit with a rebase?

chrisjsewell · 2020-10-21T00:13:33Z

yeh weird, it normally has the button here to update the branch

if you could rebase then thanks

tsutsu3 · 2020-10-21T00:34:12Z

I checked "Allow edits by maintainers"

My pc env has changed. 😢

I can't rebase, can you handle it for me? 🙏

chrisjsewell · 2020-10-21T00:37:48Z

sorted thanks @tsutsu3 😄

welcome · 2020-10-21T00:38:38Z

Congrats on your first merged pull request in this project! 🎉

Thank you for contributing, we are very proud of you! ❤️

Add simple typographic replacements

9935a20

tsutsu3 marked this pull request as draft October 19, 2020 18:55

chrisjsewell requested changes Oct 19, 2020

View reviewed changes

chrisjsewell reviewed Oct 19, 2020

View reviewed changes

Fix format

bb9b840

Change to pre-compile when using regex

523278b

Fix sphinx warnings

e38bbbd

tsutsu3 closed this Oct 20, 2020

tsutsu3 reopened this Oct 20, 2020

Fix sphinx

b07d778

chrisjsewell mentioned this pull request Oct 20, 2020

[BUG] More than 1 Block Quote in Text causes IndexError when converting to ipynb #60

Closed

chrisjsewell marked this pull request as ready for review October 21, 2020 00:11

chrisjsewell approved these changes Oct 21, 2020

View reviewed changes

Merge branch 'master' into pr/59

4308e3f

chrisjsewell changed the title ~~Add simple typographic replacements~~ ✨ NEW: Add simple typographic replacements Oct 21, 2020

chrisjsewell merged commit f290ba9 into executablebooks:master Oct 21, 2020

tsutsu3 added a commit to tsutsu3/markdown-it-py that referenced this pull request Oct 29, 2020

✨ NEW: Add smartquotes (executablebooks#59)

7cef4a2

	RARE_RE = r"\+-\|\.\.\|\?\?\?\?\|!!!!\|,,\|--"
	RARE_RE = re.compile(r"\+-\|\.\.\|\?\?\?\?\|!!!!\|,,\|--")

	SCOPED_ABBR_RE = r"\((c\|tm\|r\|p)\)"
	SCOPED_ABBR_RE = re.compile(r"\((c\|tm\|r\|p)\)", flags=re.IGNORECASE)

✨ NEW: Add simple typographic replacements #59

✨ NEW: Add simple typographic replacements #59

Uh oh!

Conversation

tsutsu3 commented Oct 19, 2020

Issue

Summary

Change

Uh oh!

welcome bot commented Oct 19, 2020

Uh oh!

chrisjsewell left a comment

Choose a reason for hiding this comment

Uh oh!

chrisjsewell Oct 19, 2020

Choose a reason for hiding this comment

Uh oh!

chrisjsewell Oct 19, 2020

Choose a reason for hiding this comment

Uh oh!

chrisjsewell commented Oct 19, 2020

Uh oh!

chrisjsewell Oct 19, 2020

Choose a reason for hiding this comment

Uh oh!

tsutsu3 Oct 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chrisjsewell Oct 19, 2020

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Oct 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

tsutsu3 commented Oct 20, 2020

Uh oh!

chrisjsewell commented Oct 20, 2020

Uh oh!

tsutsu3 commented Oct 20, 2020

Uh oh!

chrisjsewell commented Oct 20, 2020

Uh oh!

tsutsu3 commented Oct 21, 2020

Uh oh!

chrisjsewell commented Oct 21, 2020

Uh oh!

tsutsu3 commented Oct 21, 2020

Uh oh!

chrisjsewell commented Oct 21, 2020

Uh oh!

welcome bot commented Oct 21, 2020

Uh oh!

Uh oh!

tsutsu3 Oct 20, 2020 •

edited

Loading

codecov bot commented Oct 20, 2020 •

edited

Loading