From 5f041d219abfefee1ed9cd02c316ee781adc8e13 Mon Sep 17 00:00:00 2001 From: Brett Cannon Date: Mon, 31 May 2021 13:49:56 -0700 Subject: [PATCH] Clarify/tweak some comments (#308) * Clarify a comment for live_markdown.ex * Tweak grammar for docs of notebook_from_markdown() --- lib/livebook/live_markdown.ex | 2 +- lib/livebook/live_markdown/import.ex | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/livebook/live_markdown.ex b/lib/livebook/live_markdown.ex index eca2479fe..727ab9265 100644 --- a/lib/livebook/live_markdown.ex +++ b/lib/livebook/live_markdown.ex @@ -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: diff --git a/lib/livebook/live_markdown/import.ex b/lib/livebook/live_markdown/import.ex index 1d86728e7..5fb48e880 100644 --- a/lib/livebook/live_markdown/import.ex +++ b/lib/livebook/live_markdown/import.ex @@ -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())}