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

Rename Volubilis/Wikipedia corpus function names for consistency / Fix types #882

Merged
merged 1 commit into from
Dec 6, 2023

Conversation

bact
Copy link
Member

@bact bact commented Dec 6, 2023

Also

  • Add more corpus info to docstring
  • Add get_corpus_as_is() which is the former get_corpus(as_is=True) to not mixing the return type
  • Fix return type of provinces() - it must be List[dict] not List[str]
  • Fix param type of version in corpus database functions, version: str can't be None
  • Add type hints
  • Add license info
  • Deprecate thai_synonym(), use thai_synonyms() (plural) instead

Your checklist for this pull request

🚨Please review the guidelines for contributing to this repository.

  • Passed code styles and structures
  • Passed code linting checks and unit test

- Add `get_corpus_as_is()` which is the former `get_corpus(as_is=True)` to not mixing the return type
- Fix return type of `provinces()`
- Add type hints
- Add license info
@bact bact added corpus corpus/dataset-related issues refactoring a technical improvement which does not add any new features or change existing features. labels Dec 6, 2023
@bact bact added this to the 5.0 milestone Dec 6, 2023
Copy link

sonarcloud bot commented Dec 6, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@bact bact added this to In progress in PyThaiNLP Dec 6, 2023
@bact bact changed the title Rename corpus function names for consistency Rename corpus function names for consistency / Fix types Dec 6, 2023
@bact bact self-assigned this Dec 6, 2023
@bact bact merged commit 9bd951b into PyThaiNLP:dev Dec 6, 2023
7 of 12 checks passed
PyThaiNLP automation moved this from In progress to Done Dec 6, 2023
@bact bact changed the title Rename corpus function names for consistency / Fix types Rename Volubilis/Wikipedia corpus function names for consistency / Fix types Dec 6, 2023
@coveralls
Copy link

Coverage Status

coverage: 84.222% (-1.9%) from 86.156%
when pulling 94ec1fc on bact:rename-corpus-volubilis-wikipedia
into 297aadc on PyThaiNLP:dev.

@bact bact deleted the rename-corpus-volubilis-wikipedia branch December 7, 2023 01:00
@bact bact added the documentation improve documentation and test cases label Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
corpus corpus/dataset-related issues documentation improve documentation and test cases refactoring a technical improvement which does not add any new features or change existing features.
Projects
PyThaiNLP
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants