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.

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

Revise README based on the comments from @hirooih at #5 #6

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

masatake
Copy link
Member

Signed-off-by: Masatake YAMATO yamato@redhat.com

Signed-off-by: Masatake YAMATO <yamato@redhat.com>
@masatake masatake linked an issue Feb 17, 2021 that may be closed by this pull request
@masatake
Copy link
Member Author

@hirooih, can I ask you to review this change?

@@ -2,7 +2,7 @@
Reference codebase for Universal-ctags
Copy link
Collaborator

Choose a reason for hiding this comment

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

codebase -> Code Base
s/Universal-ctags/Universal Ctags/g

@@ -92,26 +93,38 @@ We assume you may have enough storage space on your PC.
How to add your code to code base
Copy link
Collaborator

Choose a reason for hiding this comment

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

A reader may not be the owner of the code.

  • How to add a code to the code base
  • How to add a project to the code base
  • How to add a git project to the code base

The last one don't not require the next sentence.

You may wan to use `--options-maybe` to extend profile without
modifying existing .ctags files.
Add a .ctags file under profile.d directory.
In the .ctags file, a line started from "# @" is used as a
Copy link
Collaborator

Choose a reason for hiding this comment

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

Before this sentence you should describe that a line started from "#" is a comment.

And now I found a ".tags file" means a "option file" described in FILES sections of man ctags(1).
If we describe that this is a option file, a reader can understand that he/she can use comment lines starting '#' and the "--options" option can be used.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Issues in README.md
2 participants