Skip to content

updates to how backtick names are converted to doc links#218

Merged
jph00 merged 1 commit into
AnswerDotAI:masterfrom
pete88b:fix-flags-link
Aug 20, 2020
Merged

updates to how backtick names are converted to doc links#218
jph00 merged 1 commit into
AnswerDotAI:masterfrom
pete88b:fix-flags-link

Conversation

@pete88b
Copy link
Copy Markdown

@pete88b pete88b commented Aug 20, 2020

Hi @jph00

this one takes care of #200 by

  • checking that a module name is also a valid doc name before linking
  • not converting parameter names to links

few other things

  • should "isnter" be "enter" in the following?
    • "Search for doc links for any item between backticks in text and isnter them"
  • should we write a map of module to notebook names to _nbdev.py - so doc_link doesn't have to assume these names correspond
  • the "not converting parameter names to links" idea works for show_doc calls for now - would you like to extend this behavior to markdown following a show_doc call too?

@review-notebook-app
Copy link
Copy Markdown

Check out this pull request on  ReviewNB

Review Jupyter notebook visual diffs & provide feedback on notebooks.


Powered by ReviewNB

@jph00
Copy link
Copy Markdown
Contributor

jph00 commented Aug 20, 2020

Great. Yes isnter is wrong. What problem would "write a map of module to notebook names" solve? What pros and cons do you see of "extending this behavior to markdown following a show_doc call"?

@jph00 jph00 merged commit c07d7e3 into AnswerDotAI:master Aug 20, 2020
@pete88b
Copy link
Copy Markdown
Author

pete88b commented Aug 21, 2020

@jph00
Copy link
Copy Markdown
Contributor

jph00 commented Aug 22, 2020

oh thanks @pete88b . can you create issues for each of those and we can discuss there?

@pete88b
Copy link
Copy Markdown
Author

pete88b commented Aug 26, 2020

@jph00 please see issues #220 and #221

@jph00 jph00 added the bug Something isn't working label Sep 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants