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

feat: add cpp dictionary files #1101

Merged
merged 4 commits into from
May 20, 2022
Merged

Conversation

david-fong
Copy link
Contributor

for #54

I've left out my boost-library file for now since it's not finished yet.

Should I make any changes to the json files in this PR? Or can I leave that to you?

@Jason3S
Copy link
Collaborator

Jason3S commented May 20, 2022

@david-fong,

Great, I'll pull these in.

Please note, it is not necessary to comment out short words like

# https://en.cppreference.com/w/cpp/header/compare
#eq
#neq
#lt
lteq
#gt
gteq

I think it is better to leave them in. It will not hurt performance.

@Jason3S Jason3S changed the title add cpp dictionary files feat: add cpp dictionary files May 20, 2022
@Jason3S
Copy link
Collaborator

Jason3S commented May 20, 2022

@david-fong,

I'll combine these into a new dictionary. Any suggestions on a name? cpp-refined was my first idea.

Note: Some people have the minimum word length set to 2, which is why it is useful to have the short words in the dictionary.
Note: Duplicate words get removed in the dictionary building process.

@Jason3S Jason3S merged commit 78abe55 into streetsidesoftware:main May 20, 2022
@Jason3S
Copy link
Collaborator

Jason3S commented May 20, 2022

@david-fong,
Thank you.

@david-fong
Copy link
Contributor Author

david-fong commented May 20, 2022

cpp-refined sounds good to me. cpp-dict-v2 could be another option. up to you.

my pleasure! I'm working on a c++ project so I'm benefitting from it too :)

thanks for being so responsive and for maintaining this project!

I'll probably want to make some more future additions. Ex. some boost library words, or words for more compiler builtins, or very-popular libraries. Let me know if there's a procedure / format for how best to do that.

@Jason3S
Copy link
Collaborator

Jason3S commented May 20, 2022

@david-fong,

I have wired everything up in #1102.

@david-fong
Copy link
Contributor Author

wonderful! looking forward to the next release :)

@david-fong
Copy link
Contributor Author

not sure where to say this. I just found out cppreference has a "symbol index" page that looks like it could be useful as an information source for some kind of automation (as opposed to how I did things manually).

@Jason3S
Copy link
Collaborator

Jason3S commented Jun 3, 2022

@david-fong,

That looks like a good resource. It might be possible with a curl command and a bit of parsing to generate a good dictionary.

This is their API: https://en.cppreference.com/mwiki/api.php
Here is the symbol index JSON src

Since they are using the Creative Commons License, it is possible to use it.

@Jason3S
Copy link
Collaborator

Jason3S commented Jun 3, 2022

not sure where to say this. I just found out cppreference has a "symbol index" page that looks like it could be useful as an information source for some kind of automation (as opposed to how I did things manually).

Just open a new issue to track using cppreference as a source.

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.

2 participants