Comments (2)
Hi, thanks for the request!
As you can tell, we opted for the alternative (tooltips/popups) instead of live docs. Part of the reason was that it's not easy to tell whether a docstring is a numpy-style doc, or RST, or markdown ... so it's not easy to render it nicely. It seems like in Julia the convention is to use markdown for docstrings (I wish this were true for Python!), which makes live docs much more visually appealing.
Would live docs be useful even if they were rendered as plain text?
(i tried it with np.linspace and shift+tab or ctrl+space doesn't seem to do it?)
Completion/tooltips for large packages (like NumPy) can be slow unfortunately. But it should eventually work (but maybe there's a bug).
If we fixed the automatic pop ups to be more consistent, would you still want live docs or would that be good enough?
from marimo.
Hi @akshayka,
I was afraid that it would be difficult to tell how to render it, as JupyterLab doesn't support that either!
For me, it'd still be useful to have the option of a permanent doc string side panel, even if in plain text. This would give me a glance of the whole doc string and I don't have to use the mouse to scroll the pop-up. I am not aware of a way to scroll with the keyboard.
If the pop-ups are instant, then that would be good enough. In the current state, it's sometimes not that convenient if the arguments are long or/and the function is overloaded:
from marimo.
Related Issues (20)
- Incorrect OS Version Displayed for Windows 11 in `marimo env` Command HOT 2
- Add SymPy equation rendering support such that the ouput is on parity with Jupyter's rendering when using SymPy. HOT 1
- Propose a New Pull Request Template for the Repository HOT 1
- [firefox] checkbox div has different height based on checked status HOT 2
- Allow replacement of cell outputs by index HOT 1
- yaml is not a default library (woops) HOT 4
- Renaming notebook doesn't change title of tab
- go to declaration does not work within def HOT 5
- Blog DAG code error HOT 1
- Notebook in the "Coming from Jupyter" section of docs throws an error HOT 6
- ASM_CONSTS[code] is not a function HOT 1
- regression bug (0.5.2->0.6.0): batch wrapped Switch looses it's on_change handler HOT 2
- I want to render bar chart based on the marimo buttons like day,week,month and year but bar chart is not rendering HOT 4
- Resuming session (refresh) loses stale status
- infinite loop with mo.state via function calling both getter and setter HOT 3
- `mo.ui.table()` view of polars dataframe fails in HTML export HOT 2
- Change md code-block style HOT 4
- ui.table renders `False` bools as `true` HOT 1
- Regression: Clicking in a cell doesn't move cursor HOT 3
- Scratchpad HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from marimo.