Comments (6)
I made it use either, because both produce the same kind of bullet in Markdown. We could normalize it to one or the other for the wiki.
For capital letters, ideally the entries should be complete sentences, so begin with a capital letter (unless the first word is a code
item), and end with a period. But it isn't enforced by the bot.
from sympy-bot.
The difference seems to be that there is no additional spacing between the items when using -, so maybe that is actually preferred. The Wiki page states *, but some frequent contributors seems to use -.
Is that true?
-
bullet- sub
-
bullet - sub
-
bullet
- sub
*
bullet- sub
*
bullet - sub
*
bullet
- sub
They seem to be the same at least for GitHub comments. As far as I know -
, *
, and +
all produce the same HTML (<li>
elements).
from sympy-bot.
Good question. It indeed looked like that in the release notes, but I cannot say I see any difference here. Didn't check the HTML either.
OK! I'll update the Wiki when I remember so that the examples are complete sentences. May help a bit.
from sympy-bot.
It seems like -
gives a paragraph environment <p>...</p>
, except for the first bullet (or if it is after a *
. Check out e.g. the printing section in https://github.com/sympy/sympy/wiki/Release-Notes-for-1.5
<li>
<p>printing</p>
<ul>
<li>Added support for <code>HadamardPower</code> in latex printer. (<a href="https://github.com/sympy/sympy/pull/16474">#16474</a> by <a href="https://github.com/sylee957">@sylee957</a> and <a href="https://github.com/Upabjojr">@Upabjojr</a>)</li>
</ul>
<ul>
<li>Fixed alignment of expressions inside sums in pretty printer (<a href="https://github.com/sympy/sympy/pull/16503">#16503</a> by <a href="https://github.com/anpandey">@anpandey</a>)</li>
</ul>
<ul>
<li>
<p>Add support for <code>HadamardProduct</code> in mathml presentation printer. (<a href="https://github.com/sympy/sympy/pull/16483">#16483</a> by <a href="https://github.com/sylee957">@sylee957</a>)</p>
</li>
<li>
<p>pretty printing of BaseScalar and BaseVector matches the latex form with CoordSys as subscript (<a href="https://github.com/sympy/sympy/pull/16422">#16422</a> by <a href="https://github.com/kangzhiq">@kangzhiq</a> and <a href="https://github.com/smichr">@smichr</a>)</p>
</li>
</ul>
</li>
from
* printing
- Added support for `HadamardPower` in latex printer. ([#16474](https://github.com/sympy/sympy/pull/16474) by [@sylee957](https://github.com/sylee957) and [@Upabjojr](https://github.com/Upabjojr))
* Fixed alignment of expressions inside sums in pretty printer ([#16503](https://github.com/sympy/sympy/pull/16503) by [@anpandey](https://github.com/anpandey))
- Add support for `HadamardProduct` in mathml presentation printer. ([#16483](https://github.com/sympy/sympy/pull/16483) by [@sylee957](https://github.com/sylee957))
- pretty printing of BaseScalar and BaseVector matches the latex form with CoordSys as subscript ([#16422](https://github.com/sympy/sympy/pull/16422) by [@kangzhiq](https://github.com/kangzhiq) and [@smichr](https://github.com/smichr))
from sympy-bot.
Interesting. I don't see anything in the commonmark spec about mixing bullet types. Although I don't know if the GitHub wikis use string commonmark. The spec seems to imply that
is used whenever there is a blank line between the items.
In the printing section of the 1.5 notes, there is clearly more vertical space after the second bullet. So maybe it is worth changing this.
from sympy-bot.
Let's modify what the bot produces instead of forcing people to use a certain bullet type. The bot collects list items so the first character should always be -
, *
, or +
, so we can easily canonicalize it.
from sympy-bot.
Related Issues (20)
- Heroku ending free tier HOT 9
- Render deliveries are timing out HOT 13
- Automatic tagging and assigning of Pull Requests and Issues HOT 4
- Check for people adding author information
- Do some basic linting of the PR description
- Let the bot give people triage access HOT 1
- Better error for bad bullet on the header
- Assign the issue to the person who opened the pull request HOT 3
- Benchmark report
- Warn on new or deleted files HOT 6
- Make the webapp tests easier to maintain
- Status not updated sometimes HOT 6
- Recognize co-authored-by in commit messages HOT 4
- Detect orphan commits
- Make this a GitHub app
- Use the same comment for release notes and file added checks HOT 4
- Is it possible (or not to hard) to have the bot ping a github handle on a PR if it affects specific SymPy modules? HOT 7
- Add automatic Binder deployment for commits HOT 2
- SymPy bot error in merging release notes HOT 1
- Update the wiki push test
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 sympy-bot.