livebook-dev/livebook
1
1
Fork 0
mirror of https://github.com/livebook-dev/livebook.git synced 2025-03-03 18:35:41 +08:00
Code Issues Projects Releases Packages Wiki Activity

Clarify/tweak some comments (#308)

Browse source 
* Clarify a comment for live_markdown.ex

* Tweak grammar for docs of notebook_from_markdown()
This commit is contained in:
Brett Cannon 2021-05-31 13:49:56 -07:00 committed by GitHub
parent 5c122e63cb
commit 5f041d219a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
lib/livebook/live_markdown.ex
View file

@ -6,7 +6,7 @@ defmodule Livebook.LiveMarkdown do
# The format is based off of Markdown and preserves compatibility,
# in the sense that every LiveMarkdown file is a valid Markdown file.
# LiveMarkdown uses HTML comments for storing metadata, so a Markdown standard
# supporting that is assumed. Not every Markdown file is a valid LiveMarkdown file,
# supporting such comments is assumed. Not every Markdown file is a valid LiveMarkdown file,
# but may be converted to such by applying tiny changes, which the import function does.
#
# Currently the format is straightforward and specifies the following:

2
lib/livebook/live_markdown/import.ex
View file

@ -5,7 +5,7 @@ defmodule Livebook.LiveMarkdown.Import do
@doc """
Converts the given Markdown document into a notebook data structure.
Returns the notebook structure and list if informative messages/warnings
Returns the notebook structure and a list of informative messages/warnings
related to the imported input.
"""
@spec notebook_from_markdown(String.t()) :: {Notebook.t(), list(String.t())}