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

Doc: Add API Doc (#12) #23

Merged
merged 28 commits into from
Mar 5, 2024
Merged

Doc: Add API Doc (#12) #23

merged 28 commits into from
Mar 5, 2024

Conversation

41ow1ives
Copy link
Collaborator

@41ow1ives 41ow1ives commented Mar 5, 2024 •
edited
Loading

PR Checklist

Please check if your PR fulfills the following requirements:

  • [V] The commit message follows dataverse guidelines link:
  • [V] Tests for the changes have been added (for bug fixes / features)
  • [V] Docs have been added / updated (for bug fixes / features)

What does this PR do?

  1. Changed folder name guideline -> examples
    : I know this is out of scope, aplogies.
  2. Edit precommits
    : edited formats, and add some ignores on flake8.
  3. Updated overall docstring in google style and added some descriptions.
  4. Unified accent.py into char.py
  5. Added some logics on registry.py to pass the document building process
  6. Initial commit for docs. (under docs/ folder)
  7. Also out of scope, but added detail info about what is ETL on main README.md

41ow1ives added 25 commits March 5, 2024 09:40
@41ow1ives
docs: change folder name
2235f2d
@41ow1ives
refactor: edit precommit foramt
a652e1d
@41ow1ives
docs: modify docstring, add license in cleaning (#12)
15584de
@41ow1ives
docs: unify accent.py into char.py (#12)
0cb4b9a
@41ow1ives
add ignore E203, E501, W503 to flake8
eb30eb9 
because without ignoring E203, makes conflict with black's policy.

ignore E501 (line too long error)

since line lengths are checked by black, it doesn't need to alert an error about it.

add W503

recent PEP8 recommends to break before binary operator
@41ow1ives
docs: modify docstring, add license, typo in cleaning (#12)
db2c0e6 
docs: modify docstring, add license, typo (#12)

docs: modify docstring, add license, typo (#12)

docs: modify docstring, add license, typo (#12)
@41ow1ives
docs: modify docstring, add license, typo in cleaning (#12)
968a20d
@41ow1ives
docs: modify docstring, add license, typo in data_ingestion (#12)
80e5e21
@41ow1ives
docs: modify docstring, add license, typo in data_load (#12)
f97d6e2
@41ow1ives
docs: modify docstring, add license, typo in deduplication (#12)
4bb08eb
@41ow1ives
docs: modify docstring, add license, typo in pii (#12)
c629157
@41ow1ives
docs: modify docstring, add license, typo in quality (#12)
0d72c76
@41ow1ives
docs: modify docstring, add license, typo in utils (#12)
9a5f1a0
@41ow1ives
docs: modify docstring, add license, typo in pipeline (#12)
c750aaa
@41ow1ives
docs: modify docstring, add license, typo in registry (#12)
5c2b749
@41ow1ives
add: add pass logic and etl_cls attributes (#12)
16e1a22 
This is for documentation - sphinx \n - Pass logic for already registered keys \n - add two attributes to etl_cls to help sphinx to find docstring of registered functions
@41ow1ives
add: initial commit for sphinx (#12)
c90e29c
@41ow1ives
add: add extensions, theme setting (#12)
af2c3a7
@41ow1ives
add: add setup to find docstring and pass non-ETL functions (#12)
4cf8b26
@41ow1ives
docs: notify not implemented (#12)
e08e547
@41ow1ives
refactor: add @wraps for sphinx (#12)
684da62
@41ow1ives
docs: revise import(#12)
904a0f8
@41ow1ives
add: add theme for sphinx (#12)
d17119a
@41ow1ives
add: add temp environment while building docs (#12)
8c4b33e
@41ow1ives
add: initial commit for documentation (#12)
2775e48
@41ow1ives 41ow1ives requested a review from Parkchanjun March 5, 2024 13:17
@41ow1ives 41ow1ives merged commit 8cc6ce8 into UpstageAI:main Mar 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Parkchanjun Parkchanjun Parkchanjun approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@41ow1ives @Parkchanjun