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

Update advanced usage docs #1244

Merged
merged 3 commits into from May 3, 2018
Merged

Update advanced usage docs #1244

merged 3 commits into from May 3, 2018

Conversation

styfle
Copy link
Member

@styfle styfle commented Apr 30, 2018

Description

This adds a couple missing option types to the docs and also shows the version introduced for headerIds.

Contributor

  • no tests required for this PR.

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

@styfle styfle added the category: docs Documentation changes label Apr 30, 2018
@styfle
Copy link
Member Author

styfle commented Apr 30, 2018

@joshbruce @UziTech @davisjam I'm thinking of adding 2 additional columns to the options table:

  • default value
  • since version

Do you think that's a good idea?

@joshbruce
Copy link
Member

tl;dr: Not a fall of the sword for me. Just some things to consider.

I definitely think having default following type would be good. My only reservation on since would be in keeping up if they're out of sync. Though it does open the door for a deprecated column as well when we get there.

@@ -41,18 +41,18 @@ console.log(myMarked('I am using __markdown__.'));

|Member |Type |Notes |
|:-----------|:---------|:----------------------------------------------------------------------------------------------------------------------------|
|baseUrl |`??` |Default is `null` |
|baseUrl |`string` |A prefix url for any relative link. Default is `null` |
Copy link
Member

@joshbruce joshbruce Apr 30, 2018

Choose a reason for hiding this comment

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

If we add the columns, think the order would be:

|Member |Type |Default |Added in |Notes |

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks! I went with Since and put v0.4.0 so its clear that its clear that this is a version number. I couldn't easily find when these other features were introduced so I used ???

@styfle styfle requested a review from davisjam May 2, 2018 15:07
@styfle
Copy link
Member Author

styfle commented May 2, 2018

My only reservation on since would be in keeping up if they're out of sync

I don't understand this reservation. What would get out of sync?

Though it does open the door for a deprecated column as well when we get there.

I like the idea of deprecating too if we ever reach that point.

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
Copy link
Member Author

styfle commented May 3, 2018

@joshbruce Any opposition here?

zhenalexfan pushed a commit to zhenalexfan/MarkdownHan that referenced this pull request Nov 8, 2021
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.

None yet

3 participants