Closed ccmao1130 closed 2 weeks ago
I'd like to work on this issue. Having trouble building the docs locally but trying best.
@willvo2004 if there are any issues you are running into while building the docs that likely affect others, feel free to open up separate issues for those!
Currently having trouble getting documentation changes through; would appreciate direction:
fn docstrings(&self, _alias: &str) -> String {
match self {
Self::EndsWith => "Returns true if the string ends with the specified substring".to_string(),
Self::StartsWith => "Returns true if the string starts with the specified substring".to_string(),
Self::Contains => "Returns true if the string contains the specified substring".to_string(),
.
.
.
Self::Normalize(_) => "Does something cool".to_string(),
}
}
Changes were made to src/daft-sql/src/modules/utf8.rs
under the docstrings function.
Changes to documention docstring are to be made here (I could be wrong)
Running the folllowing build commands for sphinx under daft/docs
make clean
make html
Docstring on documentation site does not appear to be changed and I'm not sure why this is happening. Been trying to trace for a while.
Do I have to change conf.py
?
@willvo2004 I think the tricky thing with these docstrings is that you first have to build the Daft Rust project: make build
This will build the Rust package, which is then accessible via Python (and hence Sphinx)
Describe the bug
Several doc pages for SQL (API Documentation -> SQL) look like this:
Below are all the incomplete SQL docs:
And when you search for "normalize", why does it look like this?
To Reproduce
No response
Expected behavior
No response
Component(s)
SQL
Additional context
No response