Comments (4)
Agree with points 2 and 3. One comment on 2" backticks are not necessarily bad, and useful especially when referring to names with underscores, because that prevents formatting in release notes from going wrong (PR titles are included, and underscores are special syntax in reST.
Point 1 is a bit more complex. I agree with the first part. However, if there's a single commit that fixes an issue and you don't force-push that a lot, then adding Closes gh-1234
in the commit message is helpful. Commit messages need to be descriptive, and for future debugging it's quite relevant to see what a commit fixed without having to figure out what PR it was included in. So this is more a "it depends".
from scipy.
For item 2, spaces are not needed around colons since commit message is limited space so better spend it on making the commit message clearer instead. Hence MAINT:fft:Some commit message
is fine and makes grepping much easier.
from scipy.
For item 2, spaces are not needed around colons since commit message is limited space so better spend it on making the commit message clearer instead. Hence MAINT:fft:Some commit messageis fine and makes grepping much easier.
Point taken, but most people do put spaces around the colons1, so I think it's probably not worth enforcing either way - maybe saying that either is okay (or including both in examples) makes sense.
Footnotes
-
and I think it looks nicer... ↩
from scipy.
That all makes sense. This issue was partly motivated by the guidance to 'name and describe your PR as you would write a
commit message'. I think Closes gh-1234
is one case where it would be useful to draw a distinction between the two - "it depends" for commit messages, as you say, but almost never good for PR titles.
from scipy.
Related Issues (20)
- BUG: ImportError: DLL load failed while importing nct_ufunc HOT 11
- ENH: stats.cauchy: improve cdf and quantile accuracy in tail HOT 9
- BUG: sparse.csgraph, array types: some functions should expect a fill-value other than zero HOT 6
- BUG: optimize.minimize: garbage collection in `lbfgs` HOT 9
- MAINT: `spatial.distance.jensenshannon` returns `nan` for contrived input HOT 1
- BUG: Build failure on PyPy3.10 7.3.16: `error: ‘Py_Initialize’ was not declared in this scope` HOT 6
- BUG: special.hyp1f1: broken for complex argument HOT 4
- BUG: test_discrete_basic fails on scipy-1.13.1-cp311-cp311-win_arm64 HOT 12
- MAINT, TST: pytest-fail-slow and local concurrent runs/variability HOT 1
- Failures for new `pytest-fail-slow` check in Windows CI jobs HOT 7
- TST: my local test failures HOT 14
- BUG: ``optimize.nnls`` sometimes fails when input ``A`` is a Fortran order array HOT 4
- BUG: `sparse.csgraph.minimum_spanning_tree`: 64bit indices unsupported HOT 1
- BUG: `stats.levy_stable.rvs`: "S0"-parameterization ignored
- BUG: SLSQP Inequality constraints incompatible when no constraints are present or constraints are respected HOT 7
- BUG: Numerically incorrect `scipy.signal.savgol_coeffs` (also affects `scipy.signal.savgol_filter`) HOT 8
- ENH: Add option to pass a single function to compute fun and jac in scipy.optimize.least_squares HOT 5
- query: scipy.signal.ShortTimeFFT import does not work HOT 1
- BUG: special.fdtri: inaccurate results for extreme arguments (exposed via scipy.stats.f.ppf) HOT 3
- DOC: Discourse release notes character limit HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from scipy.