Skip to content

Add undocumented option descriptions #1312

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 30, 2018
Merged

Add undocumented option descriptions #1312

merged 1 commit into from
Jul 30, 2018

Conversation

@hail2u
Copy link
Contributor

@hail2u hail2u commented Jul 29, 2018 •
edited by styfle
Loading

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

@hail2u
Add un-doumented notes in options
8542042 
`???` is useless. They should be documented as well as other options.
@styfle styfle requested review from UziTech and joshbruce 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
UziTech
UziTech approved these changes Jul 30, 2018
View reviewed changes
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
@snyk-bot snyk-bot mentioned this pull request Aug 19, 2019
Open
This was referenced Aug 30, 2019
Open
Open
@snyk-bot snyk-bot mentioned this pull request Sep 24, 2019
Open
This was referenced Oct 26, 2019
Open
Open
Open
Closed
Open
@snyk-bot snyk-bot mentioned this pull request Nov 4, 2019
Open
This was referenced Nov 18, 2019
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
This was referenced Mar 29, 2020
Open
Open
Open
Open
Open
Open
Open
Open
Open
This was referenced Apr 5, 2020
Open
Open
Open
Open
Open
Open
Open
Open
Open
Closed
Open
Open
Closed
Open
Open
Open
This was referenced Apr 12, 2020
Open
Open
Open
Open
zhenalexfan pushed a commit to zhenalexfan/MarkdownHan that referenced this pull request Nov 8, 2021
@styfle
Merge pull request markedjs#1312 from hail2u/patch-2
461e594 
Add undocumented option descriptions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@UziTech UziTech UziTech approved these changes

@styfle styfle styfle approved these changes

@joshbruce joshbruce Awaiting requested review from joshbruce

Assignees

No one assigned

Labels

category: docs Documentation changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@hail2u @UziTech @styfle