Comments (5)
It would be very good to update the Description -part of the Commentary to remove the version layers.
Regarding the Changes -part:
- The reason for that to be in the Commentary is that when this package is received through MELPA, this file is the only one that is received. I.e. git log is not visible there.
- Having a changes -part in the Commentary is quite rare in Emacs packages, but I think I modeled it after
el-get
,which looks a bit similar. - Having separate readmes and changelogs is a bit against MELPA contributing guidelines: https://github.com/melpa/melpa/blob/master/CONTRIBUTING.org
- IIUC this is because information would be lost as user may not be able to find it (from a separate file somewhere under .emacs.d).
- Having the README.md generated from the package is only for displaying the information in Github.
- One problem with the section is that it is out-of-sync with the authoritative changelog, git commits. I was thinking of only listing more major changes (changes only for major and minor version bumps, ignoring patch-level) in the future.
Regarding the generating the README.md:
- It can be done with the command (link for the script is at the bottom of the README):
emacs --script make-readme-markdown.el < helm-grepint.el > README.md
- It needs to be changed manually a bit: It adds the
-*- lexical-binding: t -*-
as part of the title.
from helm-grepint.
I did some clarifying of the Commentary section in commit d22947c.
Hopefully it is a bit less convoluted.
from helm-grepint.
That's better; thanks!
from helm-grepint.
I think this issue can be closed?
from helm-grepint.
Yeah, let's close this.
Thanks!
from helm-grepint.
Related Issues (11)
- Fails to load with recent helm due to deprecation (two years ago) of `define-helm-type-attribute` HOT 1
- Problem with patterns containing double quotes HOT 3
- Either default to non-regex search, or escape the pattern HOT 7
- Git backend case-sensitive by default? HOT 2
- Cannot cycle case sensitivity HOT 1
- Minimum length of input? HOT 16
- Bug matching some regexs HOT 10
- Stable releases on MELPA stable? HOT 4
- Equivalent of `helm-grep-save-results`? HOT 2
- In `helm-grepint-grep-action-mode`, refresh should be bound to grep, not compile HOT 3
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 helm-grepint.