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

Request: issue warning when footnote is made but unused #400

Closed
kylebarbour opened this issue Dec 18, 2016 · 4 comments
Closed

Request: issue warning when footnote is made but unused #400

kylebarbour opened this issue Dec 18, 2016 · 4 comments
Assignees

Comments

@kylebarbour
Copy link

@kylebarbour kylebarbour commented Dec 18, 2016

I could be wrong, but I have a distinct memory of kramdown issuing a warning when footnotes are defined but not cited. Apologies if that memory is incorrect --- but either way, I think this would save me frequently, because I write long documents with occasionally > 100 citations and it's easy to write a long footnote and forget to cite it, and the software doesn't provide a way to help remind you. For example, in the following code,

Lorem ipsum.

[^foo]:
    bar

which produces

<p>Lorem ipsum.</p>

with no footnote, it would be really nice if a warning was issued saying something like "Warning: footnote 'foo' on line baz unreferenced - ignoring" so you can go check and make sure you actually wanted to do that. Presently, warnings are issued for duplicate footnotes (Warning: Duplicate footnote name 'foo' on line baz - overwriting) and for footnotes with no definition (Warning: Footnote definition for 'foo' not found on line baz), so I think there may already be some infrastructure that would allow checking this.

Thanks for considering!

@gettalong gettalong self-assigned this Dec 19, 2016
@gettalong
Copy link
Owner

@gettalong gettalong commented Dec 19, 2016

Thanks, this is a good idea - will do this for the next release if easily possible!

Loading

@gettalong
Copy link
Owner

@gettalong gettalong commented Jan 7, 2017

Done! 😄

Loading

@gettalong gettalong closed this Jan 7, 2017
@kylebarbour
Copy link
Author

@kylebarbour kylebarbour commented Feb 10, 2017

You are, as always, the best :) Thanks!

Loading

@gettalong
Copy link
Owner

@gettalong gettalong commented Feb 11, 2017

😄 Thanks!

Loading

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants