Improve docstrings for ttl and max_entries
#6733
Merged
+26
−16
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
snehankekre
suggested changes
May 23, 2023
Contributor
There was a problem hiding this comment.
@sfc-gh-jrieke We use reStructuredText in our docstrings. Code should be enclosed in two backquotes, not single. Single backquotes are for italics: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#inline-markup
Additionally, you've switched to Markdown for inline external links. They should again be in reST format: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#external-links
Pending the above changes, the bulleted list looks SO much better. Thanks, Johannes!
snehankekre
approved these changes
May 23, 2023
tconkling
added a commit
to tconkling/streamlit
that referenced
this pull request
May 30, 2023
* develop: (22 commits) enzyme -> react-testing-library (Countdown, Modal, ProgressBar) (streamlit#6744) Remove console.log (streamlit#6753) Update `st.data_editor` and `st.dataframe` docstrings (streamlit#6752) Update `st.data_editor` session state format (streamlit#6711) Cypress flaky test fixes (streamlit#6743) Document integer size limit for number_input and slider (streamlit#6724) Change default theme hash on app init (streamlit#6729) Use .genericFonts instead of .fonts to fix bug with theme postMessage. (streamlit#6732) Improve startup performance by lazy loading some dependencies (streamlit#6531) Add support for Altair 5 (streamlit#6618) Update modals (streamlit#6688) Improve docstrings for `ttl` and `max_entries` (streamlit#6733) Improve `st.columns` docstring (streamlit#6727) Removed orphan line in dataframe docstring (streamlit#6734) Fix useIsOverflowing dependency array (streamlit#6731) Remove experimental from data editor (streamlit#6712) Clarify set_page_config docstring and exception message (streamlit#6594) Add a config option to disable warning for setting both a widget default and its key in session_state (streamlit#6640) Add column configuration API for `st.dataframe` and `st.data_editor` (streamlit#6598) Migrate datetime column formatting from date-fns to momentJS (streamlit#6702) ...
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.
Makes the docstring for
ttlonst.cache_dataandst.cache_resourcea bit nicer to read by explicitly listing all options. I moved the new str option before timedelta because I think it will be used more (and we should promote it!). Also changed a few nits in themax_entriesdocstring while I was at it.📚 Context
What kind of change does this PR introduce?
🧠 Description of Changes
Contribution License Agreement
By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.