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

Update docs/optlib #2032

Merged
merged 6 commits into from
May 13, 2019
Merged

Update docs/optlib #2032

merged 6 commits into from
May 13, 2019

Conversation

dreamtigers
Copy link
Contributor

  • Fixed typos
  • Rewrote some paragraphs for clarity
  • Reviewed previously unreviewed sections (specially the ones of _roles, _fields, _extras)

In lines 1573 to 1575 and 1621 to 1626 and maybe others, I used the first person ("Here I will explain...") because the paragraphs were written that way, but in no way that means my person (@dreamtigers) is the voice doing the explanation. In any case, it should be @masatake, with their permission. If it's an issue, I can rewrite those sections to use a neutral voice.

Before merging this, I will open an issue to discuss some doubts I have with some sections. Should those doubts be resolved, I can commit the additional changes, and then this pull request can be merged successfully.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 85.237% when pulling a463521 on dreamtigers:docs/optlib into 6cecfb9 on universal-ctags:master.

@masatake
Copy link
Member

masatake commented Mar 7, 2019

Before merging this, I will open an issue to discuss some doubts I have with some sections. Should those doubts be resolved, I can commit the additional changes, and then this pull request can be merged successfully.

I see. THANK YOU VERY MUCH.

@masatake
Copy link
Member

masatake commented Mar 7, 2019

Neutral voice is better. I didn't do so because I could not do in my English skill.
I'm happy if you rewrite the sentences in neutral voice.
Not only the document is improved, but I can also learn English writing from your change.

If you are interested in improving the other parts of ctags in the long term, let me know.
I will invite you as a member of this project. So you can merge your changes quickly.

I cannot do much for you in rerun but I can help you to convert Elixir parser to mtable-regex based :-P.

@dreamtigers
Copy link
Contributor Author

I will resume work with this in a few days.

Thank you for the compliment! Although my English isn't so good, hope it serves you well!

Thank you for the invitation! But I have to refuse right now due to internet availability issues. When that improves, I'll let you know!

@masatake
Copy link
Member

I see.

:file:`.ctags` extension under the previously specified directories. If you have
multiple parser definitions, put them in different files.
To make easier the maintenance a parser defined using the options, you can put
each language parser in a different options file. Universal-ctags doesn't
Copy link
Member

Choose a reason for hiding this comment

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

SELF NOTE: each language parser => each parser

@masatake
Copy link
Member

Though using natural voice is better, the changes improve the documents much. So I will merge this after modifying the change a bit.

@masatake masatake merged commit 91c73c5 into universal-ctags:master May 13, 2019
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants