Closed vergenzt closed 4 months ago
Some of the docstrings turned out weird... We can take care of that afterwards I guess.
Which docstrings do you think are weird? I'm happy to go ahead and update now
In truth, a number of them need to be adjusted to have a good one-line summary first.
Using ast-grep (one of my favorite tools lately)...
I'm seeing 63 docstrings in total:
$ sg scan --inline-rules='id: docstrings
language: python
rule:
pattern: >-
"""$DOCSTRING"""
inside:
kind: expression_statement
inside:
any:
- kind: module
- kind: block' --json | jq '.[]' -c | wc -l
63
and 17 docstrings which contain newlines:
$ sg scan --inline-rules='id: docstrings
language: python
rule:
pattern: >-
"""$DOCSTRING"""
regex: "\n"
inside:
kind: expression_statement
inside:
any:
- kind: module
- kind: block' --json | jq '.[]' -c | wc -l
17
I don't think any of these look awful, personally. 🤷 Not sure they're a priority if it were up to me.
Up to you though. Any changes you wanna make?
Don't worry about the docstrings, we can do it later.
I'll have to fix the CI for the MacOS changes GitHub made recently. That will require rebasing, which will change the commit id for the blame-ignore file.... The fun never ends.
I think you can push an empty commit? Via git commit --allow-empty -m "retrigger ci"
or something like that
Either way - however you want to do it 😅
In this case an empty commit won't help because the actions will be run as they are on your branch. You'll need to rebase to get the CI changes I'll make (soon).
The main branch has the updated CI workflow.
Alright I've rebased and changed the SHA in .git-blame-ignore-revs
. However when I try to view blame for cogapp.py
from my branch I get an error message that "Your .git-blame-ignore-revs file is invalid".
Could that just be because the SHA hasn't been merged to the default branch yet?
I don't know the weirdness about how the file is being used, but we can fix it later.
The commit changed during the rebase, but also there was an invisible character in the middle of the hash. ¯_(ツ)_/¯
I fixed it up on main anyway.
Got it. I hadn't realized you'd be rebasing the changes onto main instead of merging. I'll leave out the .git-blame-ignore-revs
change for #34
Some of the docstrings turned out weird... We can take care of that afterwards I guess.