Tweak bug-reporting information slightly

In the README and in the FAQ, mention and link to the list of support
issues in the Github issue tracker.

Rewrite README.mdown slightly for readability and suggest the GH
tracker as primary place for YASnippet discussion.

Retire the YASnippet google group.

* README.mdown (Manual, issues, etc): Mention docs, support issues
and issue tracker separately.  Remove reference to the YASnippet
google group.
(Where are the snippets?): Properly write YASnippet for
consistency.

* doc/faq.org: Add note and link to support issues.
This commit is contained in:
João Távora 2018-04-26 10:54:30 +01:00
parent f9231b0e3d
commit b0aa5c2816
2 changed files with 17 additions and 12 deletions

View File

@ -55,7 +55,7 @@ where you want YASnippet enabled.
<a name="import"></a> <a name="import"></a>
Yasnippet no longer bundles snippets directly, but it's very easy to YASnippet no longer bundles snippets directly, but it's very easy to
get some! get some!
1. [yasnippet-snippets] - a snippet collection package maintained by 1. [yasnippet-snippets] - a snippet collection package maintained by
@ -95,11 +95,16 @@ should be added like this to `yas-snippet-dirs`:
# Manual, issues etc # Manual, issues etc
Please refer to the comprehensive [documentation][docs] for full There's comprehensive [documentation][docs] on using and customising
customisation and support. If you find a bug in the code or in the YASnippet.
documentation, please report it to the main Emacs bug list,
bug-gnu-emacs@gnu.org, and put "yasnippet" somewhere in the subject. There's a [list of support issues][support-issues], with solutions to
Alternatively, you may use the [Github issue tracker][issues]. common problems and practical snippet examples.
The [Github issue tracker][issues] is where most YASnippet-related
discussion happens. Nevertheless, since YASnippet is a part of Emacs,
you may alternatively report bugs to the main Emacs bug list,
bug-gnu-emacs@gnu.org, putting "yasnippet" somewhere in the subject.
## Important note regarding bug reporting ## Important note regarding bug reporting
@ -147,16 +152,11 @@ do `git log -1` in the dir).
Any more info is welcome, but don't just paste a backtrace or an error Any more info is welcome, but don't just paste a backtrace or an error
message string you got, unless we ask for it. message string you got, unless we ask for it.
There is also a [YASnippet google group][forum]. I will keep the group
open for reference and for discussion among users. Unfortunately I
can't guarantee a timely response, so maybe it's better to create a
github issue clearly marking your intent (user support/bug/feature
request).
Finally, thank you very much for using YASnippet! Finally, thank you very much for using YASnippet!
[docs]: http://joaotavora.github.io/yasnippet/ [docs]: http://joaotavora.github.io/yasnippet/
[issues]: https://github.com/joaotavora/yasnippet/issues [issues]: https://github.com/joaotavora/yasnippet/issues
[support-issues]: https://github.com/joaotavora/yasnippet/issues?q=label%3Asupport
[googlecode tracker]: http://code.google.com/p/yasnippet/issues/list [googlecode tracker]: http://code.google.com/p/yasnippet/issues/list
[forum]: http://groups.google.com/group/smart-snippet [forum]: http://groups.google.com/group/smart-snippet
[melpa]: http://melpa.milkbox.net/ [melpa]: http://melpa.milkbox.net/

View File

@ -2,6 +2,11 @@
#+TITLE: Frequently Asked Questions #+TITLE: Frequently Asked Questions
- *Note*: In addition to the questions and answers presented here,
you might also with to visit the list of [[https://github.com/joaotavora/yasnippet/issues?q=label%3Asupport][solved support issues]] in
the Github issue tracker. It might be more up-to-date than this
list.
* Why is there an extra newline? * Why is there an extra newline?
If there is a newline at the end of a snippet definition file, If there is a newline at the end of a snippet definition file,