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

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

Merged
merged 5 commits into from Dec 16, 2020

Conversation

@oprypin
Copy link
Member

@oprypin oprypin commented Dec 12, 2020

Fixes #186
Fixes #192

@pawamoy pawamoy force-pushed the oprypin:extfix branch from e685c3a to 4641d37 Dec 16, 2020
@pawamoy
Copy link
Member

@pawamoy 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
Member

@pawamoy pawamoy commented Dec 16, 2020

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

@pawamoy
Copy link
Member

@pawamoy 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
Member Author

@oprypin 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
Member Author

@oprypin 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
Member

@pawamoy 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
Member Author

@oprypin 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.

@pawamoy pawamoy merged commit 74e2d8a into mkdocstrings:master Dec 16, 2020
13 checks passed
13 checks passed
quality
Details
tests (ubuntu-latest, 3.6)
Details
tests (ubuntu-latest, 3.7)
Details
tests (ubuntu-latest, 3.8)
Details
tests (ubuntu-latest, 3.9)
Details
tests (macos-latest, 3.6)
Details
tests (macos-latest, 3.7)
Details
tests (macos-latest, 3.8)
Details
tests (macos-latest, 3.9)
Details
tests (windows-latest, 3.6)
Details
tests (windows-latest, 3.7)
Details
tests (windows-latest, 3.8)
Details
tests (windows-latest, 3.9)
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants