Update metadata.authors & USAGE #289
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dhimmel
commented
Dec 18, 2019
| @@ -179,7 +182,7 @@ The following YAML shows the supported key–value pairs for an author: | |||
| ```yaml | |||
| github: dhimmel # strongly suggested | |||
| name: Daniel S. Himmelstein # mandatory | |||
| initials: DSH # strongly suggested | |||
| initials: DSH # optional | |||
There was a problem hiding this comment.
initials are not used anywhere by default, so seems excessive to call them "strongly suggested"
There was a problem hiding this comment.
Agreed. I think that was a remnant from deep review where we were trying to automate things like funding statements. We haven't needed them in more modern forms of Manubot.
dhimmel
commented
Dec 18, 2019
| @@ -12,6 +12,9 @@ Markdown files are identified by their `.md` extension and ordered according to | |||
| For basic formatting, check out the [CommonMark Help](https://commonmark.org/help/) page for an introduction to the formatting options provided by standard markdown. | |||
| In addition, Manubot supports an extended version of markdown, tailored for scholarly writing, which includes [Pandoc's Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown) and the extensions discussed below. | |||
|
|
|||
| The `content/02.delete-me.md` file in the Rootstock repository shows many of the elements and formatting options supported by Manubot. | |||
| See the [raw markdown](https://gitlab.com/manubot/rootstock/blob/master/content/02.delete-me.md#L) in this file and compare it to the [rendered manuscript](https://manubot.github.io/rootstock/). | |||
There was a problem hiding this comment.
Meant to help address #288 (comment).
CC @Nebucatnetzer and @vincerubinetti
There was a problem hiding this comment.
Using GitLab link to raw markdown as a workaround for isaacs/github#297. Will be slightly confusing, but not sure what is best.
agitter
approved these changes
Dec 18, 2019
dhimmel
added a commit
that referenced
this pull request
Dec 18, 2019
This build is based on 37b3378. This commit was created by the following Travis CI build and job: https://travis-ci.com/manubot/rootstock/builds/141642153 https://travis-ci.com/manubot/rootstock/jobs/268654692 The full commit message that triggered this build is copied below: Update metadata.authors & USAGE Merges #289 * Update metadata.yaml to use 'authors' * Mention delete-me.md in USAGE
dhimmel
added a commit
that referenced
this pull request
Dec 18, 2019
This build is based on 37b3378. This commit was created by the following Travis CI build and job: https://travis-ci.com/manubot/rootstock/builds/141642153 https://travis-ci.com/manubot/rootstock/jobs/268654692 The full commit message that triggered this build is copied below: Update metadata.authors & USAGE Merges #289 * Update metadata.yaml to use 'authors' * Mention delete-me.md in USAGE
ploegieku
added a commit
to ploegieku/2023-functional-homology-paper
that referenced
this pull request
Aug 6, 2024
Merges manubot/rootstock#289 * Update metadata.yaml to use 'authors' * Mention delete-me.md in USAGE
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
metadata.yaml should now use
authorsinstead ofauthor_info.Update USAGE to mention delete-me.