[PATCH] ; Fix incorrect function name in treesit manual

[PATCH] ; Fix incorrect function name in treesit manual

[Simon Pugnet]

[-- Attachment #1.1: Type: text/plain, Size: 812 bytes --]

Dear Emacs maintainers,

This is my first time posting a patch so please forgive me if I have 
made any mistakes.

I am currently working on a PHP tree sitter major mode and while 
reading the manual I noticed what I think is an error in one of the 
examples. I have attached a small patch which changes these examples, 
so if that is indeed an error then please could you apply it for me?

I'm not sure whether I'll get this new PHP tree sitter mode to a 
suitably high quality, but nevertheless I would like to start 
contributing the Emacs development so I will go ahead with completing 
the copyright assignment paperwork. The attached patch is very small 
however so I believe this is exampt from copyright assignment (I have 
marked it as such).

Kind regards,

-- 
Simon Pugnet
https://www.polaris64.net/

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: 0001-Fix-incorrect-function-name-in-treesit-manual.patch --]
[-- Type: text/x-patch, Size: 2081 bytes --]

From f090d2bc91330efa5ef4cc855db027c2930c2778 Mon Sep 17 00:00:00 2001
From: Simon Pugnet <simon@polaris64.net>
Date: Thu, 9 Feb 2023 11:33:31 +0000
Subject: [PATCH] ; Fix incorrect function name in treesit manual

An example in the documentation uses the function
'treesit-get-parser-create' which does not exist. Replace this with
'treesit-parser-create'.

* admin/notes/tree-sitter/html-manual/Multiple-Languages.html (Next):
* doc/lispref/parsing.texi (Multiple Languages):
Change example.

Copyright-paperwork-exempt: yes
---
 admin/notes/tree-sitter/html-manual/Multiple-Languages.html | 6 +++---
 doc/lispref/parsing.texi                                    | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/admin/notes/tree-sitter/html-manual/Multiple-Languages.html b/admin/notes/tree-sitter/html-manual/Multiple-Languages.html
index 65507687d51..390d9082590 100644
--- a/admin/notes/tree-sitter/html-manual/Multiple-Languages.html
+++ b/admin/notes/tree-sitter/html-manual/Multiple-Languages.html
@@ -223,9 +223,9 @@
 </p>
 <div class="example">
 <pre class="example">;; Create parsers.
-(setq html (treesit-get-parser-create 'html))
-(setq css (treesit-get-parser-create 'css))
-(setq js (treesit-get-parser-create 'javascript))
+(setq html (treesit-parser-create 'html))
+(setq css (treesit-parser-create 'css))
+(setq js (treesit-parser-create 'javascript))
 </pre><pre class="example">
 
 </pre><pre class="example">;; Set CSS ranges.
diff --git a/doc/lispref/parsing.texi b/doc/lispref/parsing.texi
index cebb59b6501..72bf6874f1c 100644
--- a/doc/lispref/parsing.texi
+++ b/doc/lispref/parsing.texi
@@ -1584,9 +1584,9 @@ Multiple Languages
 @example
 @group
 ;; Create parsers.
-(setq html (treesit-get-parser-create 'html))
-(setq css (treesit-get-parser-create 'css))
-(setq js (treesit-get-parser-create 'javascript))
+(setq html (treesit-parser-create 'html))
+(setq css (treesit-parser-create 'css))
+(setq js (treesit-parser-create 'javascript))
 @end group
 
 @group
-- 
2.39.1


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 861 bytes --]

Re: [PATCH] ; Fix incorrect function name in treesit manual

[Yuan Fu]

> On Feb 9, 2023, at 3:46 AM, Simon Pugnet <simon@polaris64.net> wrote:
> 
> Dear Emacs maintainers,
> 
> This is my first time posting a patch so please forgive me if I have made any mistakes.
> 
> I am currently working on a PHP tree sitter major mode and while reading the manual I noticed what I think is an error in one of the examples. I have attached a small patch which changes these examples, so if that is indeed an error then please could you apply it for me?
> 
> I'm not sure whether I'll get this new PHP tree sitter mode to a suitably high quality, but nevertheless I would like to start contributing the Emacs development so I will go ahead with completing the copyright assignment paperwork. The attached patch is very small however so I believe this is exampt from copyright assignment (I have marked it as such).

Thanks, applied! The commit message is in the right format, nice! I would send patches like this straight to debbugs, also we need to use two spaces after each sentence when writing any prose in Emacs codebase. I don’t have the assignment form but someone should send you one soon.

Yuan

Re: [PATCH] ; Fix incorrect function name in treesit manual

[Eli Zaretskii]

> From: Yuan Fu <casouri@gmail.com>
> Date: Thu, 9 Feb 2023 23:41:25 -0800
> Cc: Emacs developers <emacs-devel@gnu.org>,
>  Stefan Monnier <monnier@iro.umontreal.ca>
> 
> > I'm not sure whether I'll get this new PHP tree sitter mode to a suitably high quality, but nevertheless I would like to start contributing the Emacs development so I will go ahead with completing the copyright assignment paperwork. The attached patch is very small however so I believe this is exampt from copyright assignment (I have marked it as such).
> 
> Thanks, applied! The commit message is in the right format, nice! I would send patches like this straight to debbugs, also we need to use two spaces after each sentence when writing any prose in Emacs codebase. I don’t have the assignment form but someone should send you one soon.

Form sent off-list.

Thanks.

Re: [PATCH] ; Fix incorrect function name in treesit manual

[Simon Pugnet]

[-- Attachment #1: Type: text/plain, Size: 764 bytes --]

Yuan Fu <casouri@gmail.com> writes:

>> On Feb 9, 2023, at 3:46 AM, Simon Pugnet <simon@polaris64.net> 
>> wrote:
>> 
>> Dear Emacs maintainers,
>> 
>> This is my first time posting a patch so please forgive me if I 
>> have made any mistakes.
>> 
> Thanks, applied! The commit message is in the right format, nice! I
> would send patches like this straight to debbugs, also we need to 
> use
> two spaces after each sentence when writing any prose in Emacs
> codebase. I don’t have the assignment form but someone should send 
> you
> one soon.

Thanks for the feedback! I'll be sure to take it into account and to 
send patches like this to bug-gnu-emacs@gnu.org in future.

Kind regards,

-- 
Simon Pugnet
https://www.polaris64.net/

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 861 bytes --]