DOC: Backticks missing in pandas.DataFrame.query

[bersbersbers]

Location of the documentation

https://pandas.pydata.org/docs/dev/reference/api/pandas.DataFrame.query.html

Documentation problem

Suggested fix for documentation

Backticks should be shown for the second Area (cm^2).

[rhshadrach]

Thanks for the report @bersbersbers! PR to fix would be most welcome.

[sstiijn]

Hello, I am new to contributing to open source and I am trying to get started. I am following the contributing to pandas guide and this issue seems to be a good first issue to try and get started.

[sstiijn]

take

[sstiijn]

@rhshadrach I think the first "Area (cm^2) is also missing a double quote at the end. Should I add that as well?

[bersbersbers]

This is now online:

Shouldn't the second "Area (cm^2)" instead be marked as code with `double (in this case, triple) backticks, like here

pandas/pandas/core/frame.py

Lines 3806 to 3807 in 4007513

	For example, if one of your columns is called ``a a`` and you want
	to sum it with ``b``, your query should be ```a a` + b``.

and here

pandas/pandas/core/frame.py

Lines 3889 to 3890 in 4007513

	For example, ```it's` > `that's``` will raise an error,
	as it forms a quoted string (``'s > `that'``) with a backtick inside.

[sstiijn]

@bersbersbers Good point. So concretely you would suggest that the docstring needs to be updated to

(For example, a column named "Area (cm^2)" would be referenced as ```Area (cm^2)```).
?

[bersbersbers]

I have no way to test it, but I think yes.

[sstiijn]

@bersbersbers this would be the result

[bersbersbers]

Makes a lot of sense to me!