Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(man): write about guest parsers #3892

Merged
merged 1 commit into from
Dec 25, 2023
Merged

docs(man): write about guest parsers #3892

merged 1 commit into from
Dec 25, 2023

Conversation

masatake
Copy link
Member

Close #3888
Close #3007

@codecov Codecov
Copy link

codecov bot commented Dec 22, 2023 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (bea6f5b) 85.29% compared to head (aa39241) 85.29%.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #3892   +/-   ##
=======================================
  Coverage   85.29%   85.29%           
=======================================
  Files         232      232           
  Lines       55786    55786           
=======================================
  Hits        47582    47582           
  Misses       8204     8204

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@masatake masatake added this to the 6.1 milestone Dec 22, 2023
hirooih
hirooih requested changes Dec 23, 2023
View reviewed changes
Copy link
Contributor

@hirooih hirooih left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is very clearly written in general.
I commented on the questions I had when I read it.

A typo should be fixed.

Others are comments.

docs/man/ctags-client-tools.7.rst Outdated Show resolved Hide resolved
docs/man/ctags-client-tools.7.rst Outdated Show resolved Hide resolved
docs/man/ctags-client-tools.7.rst Outdated Show resolved Hide resolved
docs/man/ctags-client-tools.7.rst Outdated
Comment on lines 389 to 391
If the client tool knows what is ``c`` in JavaScript and what is ``c`` in CSS,
the ``language:`` field provides enough information. If not, enabling ``K`` field with
``--fields=+K`` may be helpful.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not consistent with the description later. How about the followings?

The client tool can know what is c in JavaScript and what is c in CSS by using pseudo-tags described later.

Enabling K field with --fields=+K does not require the pseudo-tags.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

Surprisingly (and sadly), many client tools hardcode single-letter kinds and long-name kinds. Such a tool can say what is c in JavaScript input. The tool also knows the language for *.js file. I'll revise the sentences you pointed out.

@masatake
docs(man): write about guest parsers
aa39241 
Close universal-ctags#3888
Close universal-ctags#3007

Signed-off-by: Masatake YAMATO <yamato@redhat.com>
@hirooih
Copy link
Contributor

hirooih commented Dec 24, 2023

I could read very smoothly.
Thanks.

@masatake masatake merged commit c0b2352 into universal-ctags:master Dec 25, 2023
42 checks passed
@masatake
Copy link
Member Author

@hirooih Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hirooih hirooih hirooih approved these changes

Assignees
No one assigned
Labels
next-release
Projects
None yet
Milestone
6.1
2 participants
@masatake @hirooih