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

Suggestion: Turn comments at top of selection into markdown for a card #131

Open
jflam opened this issue Jun 4, 2018 · 1 comment
Open
Labels
enhancement New feature or request

Comments

@jflam
Copy link
Collaborator

jflam commented Jun 4, 2018

Consider code that looks like:

# 1. define an add() method
# 1. invoke the add() method

def add(x, y):
    return x + y

add(3, 4)

This would generate the card with the text in the comments converted into Markdown and rendered for display (as a numbered list in this case).

@jflam jflam changed the title Suggestion: Turn comments at top of selection into markdown for a cell Suggestion: Turn comments at top of selection into markdown for a card Jun 4, 2018
@ml7715 ml7715 added the enhancement New feature or request label Jun 5, 2018
@grosskc
Copy link

grosskc commented Sep 13, 2018

I like this idea, but I recommend that # is used for a normal comment, and #' is used to denote a selection of text to be rendered as markdown, a la:

#' # Beginning Python
#' 1. define an add() method
#' 2. invoke the add() method

# define add
def add(x, y):
    return x+y

# do the computation
add(3, 4)

The first three lines above would be rendered in markdown, but regular comments above would not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants