Mercurial > hg
annotate CONTRIBUTING @ 51723:9367571fea21
cext: correct the argument handling of `b85encode()`
The type stub indicated that this argument is `Optional`, which implies None is
allowed. I don't see in the documentation where that's the case for `i`[1], and
trying it in `hg debugshell` resulted in the method failing with a TypeError. I
guess it was typed as an `int` argument because the `p` format unit wasn't added
until Python 3.3[2].
In any event, 2 clients in core (`pvec` and `obsolete`) call this with no
argument supplied, and `mdiff` calls it with True. So I guess we've avoided the
None arg case, and when no arg is supplied, it defaults to the 0 initialization
of the `pad` variable in C. Since the `p` format unit accepts both `int` and
None, as well as `bool`, I'm not bothering to bump the module version- this code
is more permissive than it was, in addition to being more correct.
Interestingly, when I first imported the `cext` and `pure` methods in the same
manner as the previous commit, it dropped the `Optional` part of the argument
type when generating `util.pyi`. No idea why.
[1] https://docs.python.org/3/c-api/arg.html#numbers
[2] https://docs.python.org/3/c-api/arg.html#other-objects
author | Matt Harbison <matt_harbison@yahoo.com> |
---|---|
date | Sat, 20 Jul 2024 01:55:09 -0400 |
parents | a492610a2fc1 |
children |
rev | line source |
---|---|
30084
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
1 Our full contribution guidelines are in our wiki, please see: |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
2 |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
3 https://www.mercurial-scm.org/wiki/ContributingChanges |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
4 |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
5 If you just want a checklist to follow, you can go straight to |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
6 |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
7 https://www.mercurial-scm.org/wiki/ContributingChanges#Submission_checklist |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
8 |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
9 If you can't run the entire testsuite for some reason (it can be |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
10 difficult on Windows), please at least run `contrib/check-code.py` on |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
11 any files you've modified and run `python contrib/check-commit` on any |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
12 commits you've made (for example, `python contrib/check-commit |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
13 273ce12ad8f1` will report some style violations on a very old commit). |