Running diff on generated files (without detail sentences) #32720
Conversation
|
Thanks for contributing to openpilot! In order for us to review your PR as quickly as possible, check the following:
|
|
Meant to leave as a draft! Still working on the
Sorry about that. |
| info1, info2 = line1.split('|'), line2.split('|') | ||
| return "|".join([f"{i1} {ARROW_SYMBOL} {i2}|" if i1 != i2 else f"{i1}|" for i1, i2 in zip(info1, info2, strict=True)]) | ||
|
|
||
| def get_detail_sentence(data): |
There was a problem hiding this comment.
Maybe storing the sentence as a hoverable tooltip/alt image text would be a good idea?
I'm fine with a tiny bit of parsing logic over re-creating the sentence. Remember, any changes to the website logic would then need to be mirrored here, which is very error prone
Co-authored-by: Shane Smiskol <shane@smiskol.com>
…pace, but from reading liquid html DETAIL_SENTENCE should be added to auto generated documents now.
|
Can you post an example by the bot on your own fork? The result of this project should be a much cleaner and smaller docs diffing file, this grows the code. |
|
@sshane sure! Could you quickly explain to me how to deal with the @agniv-the-marker ➜ /workspaces/openpilot (master) $ /home/batman/pyenv/versions/3.11.4/bin/python /workspaces/openpilot/selfdrive/car/tests/test_docs.py
Traceback (most recent call last):
File "/workspaces/openpilot/selfdrive/car/tests/test_docs.py", line 8, in <module>
from openpilot.selfdrive.car.docs import CARS_MD_OUT, CARS_MD_TEMPLATE, generate_cars_md, get_all_car_docs
File "/workspaces/openpilot/openpilot/selfdrive/car/docs.py", line 13, in <module>
from openpilot.selfdrive.car.car_helpers import interfaces, get_interface_attr
File "/workspaces/openpilot/openpilot/selfdrive/car/car_helpers.py", line 6, in <module>
from openpilot.common.params import Params
File "/workspaces/openpilot/openpilot/common/params.py", line 1, in <module>
from openpilot.common.params_pyx import Params, ParamKeyType, UnknownKeyName
ModuleNotFoundError: No module named 'openpilot.common.params_pyx'I feel like I'm maybe missing something with how you're supposed to deal with cython files? Sorry for all the comments. Right now my bottleneck is just generating the CARS.md file which is importing this. |
|
You need to build params, |
| repo: context.repo.repo, | ||
| comment_id: ${{ steps.fc.outputs.comment-id }} | ||
| }) | ||
| name: PR comments |
There was a problem hiding this comment.
don't change indentation, it makes this diff unreadable
| dump_path = os.path.join(BASEDIR, "selfdrive", "car", "tests", "cars_dump", "CARS.md") | ||
| file_path = os.path.join(dump_path, "CARS.md") | ||
| def download_file(url, filename): | ||
| import requests | ||
| response = requests.get(url) | ||
| with open(filename, 'wb') as file: | ||
| file.write(response.content) | ||
| download_file("https://raw.githubusercontent.com/commaai/openpilot/master/docs/CARS.md", file_path) |
There was a problem hiding this comment.
this test simply checks that the file is up to date with any changes on the branch, you shouldn't need to change anything
|
CI is also failing |
|
This PR has had no activity for 14 days. It will be automatically closed in 3 days if there is no activity. |
|
This PR has been automatically closed due to inactivity. Feel free to re-open once activity resumes. |
Description
Updated the automatic
CARS.mdgeneration to utilizewgetanddiffinstead ofpickle, which should be better (assumes less about the file structure as well). Should resolve #32690, although this does not handle "📖 Detail Sentence Changes" as this seems to not be intrinsic to the generated markdown files immediately. Would love to get some feedback on how to incorporate that here.Verification
Simply edited the
CARS.mdfile locally to check it on my end, not included in the commit for obvious reasons.