Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

comments get printed on the UI by default

See original GitHub issue

Comment vs. strings

I believe that sreamlit is providing convenience by automatically writing the strings which are not assigned to any variable bu this is causing a trouble even comments are get written on the front end ui.

steps to reproduce: check this code

import streamlit as st
import pandas as pd

st.title('Streamlit Flaws')
st.subheader('Please Fix this')

"""
comment\n 
should not be\n
printed\n
"""

def write_html(html):
    st.markdown(html, unsafe_allow_html=True)

write_html("""
<!Doctype html>
<body>
<hr>
<h1>inside html</h1>
<h5>this string is fine</h5>
<p>when strings are enclosed inside these
```three quotation marks``` and passed as a parameter to a function they work as
string if they are directly written then they are treated as
comments do note the difference please.</p>
</body>
</html>
""")

Output

strm

Issue Analytics

State:
Created 4 years ago
Reactions:2
Comments:6 (1 by maintainers)

Top GitHub Comments

1reaction

pybokehcommented, Oct 28, 2019

Thanks for posting this. Was wondering why triple double-quote comments were being rendered. I thought triple single-quote comments should be allowed to render, but not triple double-quotes.

0reactions

khanfarhan10commented, Nov 6, 2020

I think that what streamlit does is right because in a jupyter notebook if you type out only a docstring in a code cell, it shows the output.