pds-api#169 api user guide #171
Conversation
docs/source/conf.py
Outdated
| open(markdown_filename, 'wb').write(r.content) | ||
|
|
||
| with open(markdown_filename, 'r') as f: | ||
| html_text = markdown(f.read(), output_format='html4') |
There was a problem hiding this comment.
Incompatible parameter type: Expected typing.Union[typing_extensions.Literal['html'], typing_extensions.Literal['xhtml'], None] for 2nd parameter output_format to call markdown.core.markdown but got typing_extensions.Literal['html4'].
(at-me in a reply with help or ignore)
docs/source/conf.py
Outdated
| from markdown import markdown | ||
| import pdfkit | ||
| import requests | ||
| # import pypandoc |
There was a problem hiding this comment.
When code's commented-out, I like to see a comment explaining why. Otherwise, just delete it—with extreme prejudice! 💥
There was a problem hiding this comment.
Removed unwanted comments
| ========================= | ||
|
|
||
| The Planetary Data System is a federated system of nodes that archive planetary science data. The PDS Application Programming | ||
| Interface (API) is an attempt at provide a consistent interface for sharing archival data and services across PDS, among |
There was a problem hiding this comment.
Maybe just say:
The PDS Application Programming Interface (API) provides a consistent way discover and share archival data across PDS…
The wording of "attempt to provide" makes it sound weak 🤔
There was a problem hiding this comment.
Agreed and reworded.
docs/source/conf.py
Outdated
| open(markdown_filename, 'wb').write(r.content) | ||
|
|
||
| with open(markdown_filename, 'r') as f: | ||
| html_text = markdown(f.read(), output_format='html4') |
There was a problem hiding this comment.
Incompatible parameter type: Expected typing.Union[typing_extensions.Literal['html'], typing_extensions.Literal['xhtml'], None] for 2nd parameter output_format to call markdown.core.markdown but got typing_extensions.Literal['html4'].
(at-me in a reply with help or ignore)
Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]
There was a problem hiding this comment.
@ramesh-maddegoda should this be output_format='html' instead of html4?
There was a problem hiding this comment.
It seems the previous reference of the markdown library I checked had html4. The latest https://python-markdown.github.io/reference/ has html as follows in output formats.
output_format:
Format of output.
Supported formats are:
"xhtml": Outputs XHTML style tags. Default.
"html5": Outputs HTML style tags.
The values can be in either lowercase or uppercase.
However, I changed the output_format to html to avoid this sonatype-lift issue.
…cation related files and fix sonartype-lift issues Refer to the task #169
|
updates added to this PR: #184 |
🗒️ Summary
Brief summary of changes if not sufficiently described by commit messages.
⚙️ Test Data and/or Report
One of the following should be included here:
♻️ Related Issues
#169