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

Add undocumented option descriptions #1312

Merged
merged 1 commit into from
Jul 30, 2018
Merged

Conversation

hail2u
Copy link
Contributor

@hail2u hail2u commented Jul 29, 2018

Marked version: n/a

Markdown flavor: n/a

Description

  • ??? is useless. They should be documented as well as other options.

Contributor

  • Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
  • no tests required for this PR.
  • If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

  • Draft GitHub release notes have been updated.
  • CI is green (no forced merge required).
  • Merge PR

`???` is useless. They should be documented as well as other options.
@styfle styfle requested review from joshbruce and UziTech July 30, 2018 16:34
@styfle styfle added the category: docs Documentation changes label Jul 30, 2018
@styfle styfle changed the title Add un-doumented notes in options Add undocumented option descriptions Jul 30, 2018
Copy link
Member

@UziTech UziTech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@styfle styfle merged commit 7f311d7 into markedjs:master Jul 30, 2018
This was referenced Apr 6, 2020
zhenalexfan pushed a commit to zhenalexfan/MarkdownHan that referenced this pull request Nov 8, 2021
Add undocumented option descriptions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: docs Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants