Skip to content

Fix lack of isolation of Markdown calls from the top-level Markdown#195

Merged
pawamoy merged 5 commits intomkdocstrings:masterfrom
oprypin:extfix
Dec 16, 2020
Merged

Fix lack of isolation of Markdown calls from the top-level Markdown#195
pawamoy merged 5 commits intomkdocstrings:masterfrom
oprypin:extfix

Conversation

@oprypin
Copy link
Copy Markdown
Member

@oprypin oprypin commented Dec 12, 2020

Fixes #186
Fixes #192

@pawamoy
Copy link
Copy Markdown
Member

pawamoy commented Dec 16, 2020

Thanks a lot @oprypin! You're doing great work here 🤩

So, footnotes will now appear only once, but if I understand correctly, one cannot use the same id for different footnotes in different docstrings if one's plan is to render these docstrings in the same page? If yes, I'm OK with that, and we should simply document it!

@pawamoy
Copy link
Copy Markdown
Member

pawamoy commented Dec 16, 2020

Also sorry for force-pushing, this is not good practice.

@pawamoy
Copy link
Copy Markdown
Member

pawamoy commented Dec 16, 2020

One more thing: I don't think it fixes #193, right? For footnotes we can force different IDs, so I guess for tabs one would need to use different titles if they plan on rendering them in the same page?

@oprypin
Copy link
Copy Markdown
Member Author

oprypin commented Dec 16, 2020

You are correct in all regards in your comments. Yes, I'm not handling ID collisions.

And actually yes, I'm not sure at all why you force-pushed :D.
Didn't need to rebase here at all.

Do you plan to merge this as a branch, or squash perhaps?

@oprypin
Copy link
Copy Markdown
Member Author

oprypin commented Dec 16, 2020

ID collisions are possible to handle by prefixing them, just don't know much hackery that would require.

@pawamoy
Copy link
Copy Markdown
Member

pawamoy commented Dec 16, 2020

I rebased to reword the commits 😑 I can be obsessive over little details.
I also didn't want to squash because this PR does several things and so I wanted to keep each commit 🙂

ID collisions are possible to handle by prefixing them, just don't know much hackery that would require.

OK, then let's simply document it for now. I'll add a troubleshooting item, merge, and link to the docs in the related issues. Does it sound good?

@oprypin
Copy link
Copy Markdown
Member Author

oprypin commented Dec 16, 2020

I rebased to reword the commits

Ah I see, didn't catch that. Thanks for the style fix as well.

Yes, all good then, no outstanding comments from me.

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.

Markdown headings can bust to the topmost nav level Footnote appears in all following objects after the first appearance

2 participants