Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvements #2025

Closed
xmnlab opened this issue Nov 8, 2019 · 3 comments
Closed

Documentation improvements #2025

xmnlab opened this issue Nov 8, 2019 · 3 comments

Comments

@xmnlab
Copy link
Contributor

xmnlab commented Nov 8, 2019

This is an overview about documentation current state:

  1. https://docs.ibis-project.org/
  • it is missing some backends
  1. https://docs.ibis-project.org/api.html
  • it is missing some backends
  • some functions don't have the types of parameters
  • some functions don't have the type of return
  • some functions don't have any description
  • some docstring inconsistencies, eg:
    • str/string
    • optional/default None
  • it is missing geo spatial functions / data types
  • just a few functions have examples. examples help a lot the users. Maybe would be good show a link to a tutorial when it corresponds.
  1. https://docs.ibis-project.org/extending.html#adding-a-new-backend

There is not text (it just is mentioning TBD).

  1. https://docs.ibis-project.org/backends.html

All backends just have a text TODO

@xmnlab
Copy link
Contributor Author

xmnlab commented Nov 8, 2019

@jreback @scottcode could you give some feedback / ideas about these points? also maybe add more points?

@scottcode
Copy link
Contributor

Module Aliases

One thing that made joining the project hard for me was all the module aliases that get used. It took me forever to figure out and remember what all these refer to, many of which are not intuitive: rlz, ir, sch, L, and com. I think it would be great to change those aliases (longer yet intuitive is better than short and opaque in my opinion). Or if not change them, provide a code glossary in the docs.

Add/improve documentation for new functionality

I know I haven't added Postgres UDF info to the docs yet, so I'm guilty. I don't know how much of the other great new functionality that others have been adding have made it into the docs yet.

@cpcloud
Copy link
Member

cpcloud commented Dec 17, 2021

Any documentation PR will be accepted almost unconditionally! Please submit one!

@cpcloud cpcloud closed this as completed Dec 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants