Skip to content
This repository has been archived by the owner on Apr 12, 2024. It is now read-only.

Update documentation and set up docs-pages #3

Open
vikrantdeshpande09876 opened this issue Apr 18, 2023 · 1 comment
Open

Update documentation and set up docs-pages #3

vikrantdeshpande09876 opened this issue Apr 18, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@vikrantdeshpande09876
Copy link
Collaborator

Add general documentation for package.

Update code-docstring for execute_nlp_pipeline() and other functions in the NLP script.

"""Returns the cleaned version of the annotation label after performing the following steps:

```python
remove_whitespaces()
expand_word_contractions()
replace_special_chars()
convert_number_to_word()
make_lowercase()
get_root_word()
```

Args:
    input_label (str): Input annotation label text.

Returns:
    str: Cleaned version of the annotation label text.
"""
@vikrantdeshpande09876 vikrantdeshpande09876 added the bug Something isn't working label Apr 18, 2023
@vikrantdeshpande09876 vikrantdeshpande09876 self-assigned this Apr 18, 2023
@vikrantdeshpande09876 vikrantdeshpande09876 added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers and removed bug Something isn't working labels Apr 18, 2023
@vikrantdeshpande09876
Copy link
Collaborator Author

Updated general function docs.
Need to update docs pages.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant