Digital Product Life Cycle Formatting Fix#61
Conversation
hlapp
left a comment
hlapp
left a comment
There was a problem hiding this comment.
Indeed I forgot to mention the indentation; I thought I remember the convention for this repo to make it 4 spaces, but forgot to mention that observation earlier today.
Looks all good!
| * Review (and revise as necessary) the Author/Contributor list(s). | ||
|
|
||
| [^1]: Here we use the term project at a smaller scale to mean any endeavor resulting in a digital product (dataset, ML model, code) and/or paper (e.g., for the purposes of this policy [SST](https://github.com/Imageomics/SST) is a *project*, while Butterflies is not). | ||
| [^1]: Here we use the term project at a smaller scale to mean any endeavor resulting in a digital product (dataset, ML model, code) and/or paper (e.g., for the purposes of this policy [SST](https://github.com/Imageomics/SST) is a _project_, while Butterflies is not). |
There was a problem hiding this comment.
In Markdown syntax, single asterisk and underscore are synonymous, so I'm not sure it's worth changing from one to the other. But perhaps the linter says otherwise?
There was a problem hiding this comment.
The linter defaults to underscore. I generally use underscore for italics myself and that is what GitHub does (using the button here. It hardly seems worth worrying about, but I changed it since I was editing the file anyway.
We have added a few things to the .markdownlint.json to make it less picky.
I agree, even if it's super minor, tackling it now now might be a good time to put it behind us. |
2 participants
The formatting as exported from the Google Doc was off on the bullet points, so I resolved it. Also removed the colons in the headers and replaced single asterisks with underscores. Document now conforms with linter.
Question: Did we want to ensure the remaining pages conform? Most issues seem to be surrounding spacing, so may be a good idea to clean it up so we start the template repo off fresh.