DOC: Ex03 errors docstrings #56905
DOC: Ex03 errors docstrings #56905
Conversation
There was a problem hiding this comment.
Looks good, just there is one thing I don't fully understand, but seems like an error.
If it makes things clearer, you can check the rendered version of your changes here: https://pandas.pydata.org/preview/56905/
Maybe seeing the final result helps clarify what that variable you are changing does.
pandas/io/formats/style.py
Outdated
| @@ -1968,7 +1968,7 @@ def apply_index( | |||
| input_note="an index value, if an Index, or a level value of a MultiIndex", | |||
| output_note="CSS styles as a string", | |||
| var="v", | |||
| ret='"background-color: yellow;" if v == "B" else None', | |||
| ret='"background-color: yellow;" if s == "B" else None', | |||
There was a problem hiding this comment.
I don't understand this change, aren't we breaking things? Seems like the variable is indeed v above, no? Sorry if I'm missing something.
There was a problem hiding this comment.
Yes, you are correct. The variable in question is indeed v.
I had initially changed it to s due to another error, but upon further investigation, it appears that the error has either disappeared or was simply a result of my oversight. In any case, the correct designation for now should be v. Thank you for pointing that out!
|
Uh, @datapythonista I believe the CI failure is connected to the variable we discussed earlier. It seems related to When 
|
|
And if we back to 
Part of the output of |
|
I'm attempting to address it in a more sensible manner. When considering changing 's' in 'ret', which option do you think is preferable, @datapythonista? |
|
I think one of the tricky parts of that docstring is that it's a template reused in more than one place, so we'll have to make sure that all the resulting docstrings look good. I guess the problem may be that linting is not happy with variables with only one character. Ideally we want to understand the example, and use a variable name that is meaningful instead. If you can't find a good name, maybe something like |
The previous error doesn't appear to be solely due to using a one-character variable name. Instead, I believe it stems from the fact that in
My latest solution involves setting
If I am not mistaken, I plan to enhance the readability and precision of the variable names in the example. |
|
Thanks @luke396, I had a look at https://pandas.pydata.org/preview/56905/docs/reference/api/pandas.io.formats.style.Styler.apply_index.html#pandas.io.formats.style.Styler.apply_index and everything seem perfect with the variable name now. Thanks a lot for the work on this. |
* Fix exo3 and remove unused code
* Remove unused in code_checks
* Fix 's' to 'v' in Styler.map_index() method
* Try set 's' to {var}
* Use `label` for more readable variable name
* Fix merge mistake
* Fix merge error
---------
Co-authored-by: Marc Garcia <[email protected]>
pandas.io.formats.style.Styler.map
pandas.io.formats.style.Styler.apply_index
pandas.io.formats.style.Styler.map_index
pandas.io.formats.style.Styler.format