Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

HarryKane11
Copy link
Contributor

꼼꼼히 검수해주셔서 감사합니다. 아래 사항 반영하여 커밋합니다.

  • pip install 부분에서 !를 %로 변경하였습니다.
  • 가이드 주신 typo 부분들 반영하였습니다.
  • 제목에 쓰인 백틱은 제거하였습니다.

{PR Message - Write freely, remove this bracket if unnecessary}

Author Checklist

  • PR Title Format: I have confirmed that the PR title follows the correct format. (e.g., [N-2] 07-Text Splitter / 07-RecursiveCharacterTextSplitter)

  • Committed Files: I have ensured that no unnecessary files (e.g., .bin, .gitignore, poetry.lock, pyproject.toml) are included. These files are not allowed.

  • (Optional) Related Issue: If this PR is linked to an issue, I have referenced the issue number in the PR message. (e.g., Fixes Proofread: < 06-DocumentLoader / 03-WebBaseLoader.ipynb > #418 )

  • ❌ Do not include unnecessary files (e.g., .bin, .gitignore, poetry.lock, pyproject.toml) or other people's code. If included, close the PR and create a new PR.

Review Template (Intial PR)

🖥️ OS: Win/Mac/Linux   
✅ Checklist      
 - [ ] **Template**: Tutorials follows the required template. 
 - [ ] **Table of Contents(TOC) Links**: All Table of Contents links work. (Yes/No)
 - [ ] **Image**: Image filenames follow guidelines.
 - [ ] **Imports**: All import statements use the latest versions. Ensure "langchain-teddynote" is not used. 
 - [ ] **Code Execution**: Code runs without errors.
 - Comments: {Write freely, 한국어 기술 가능}     

If no one reviews your PR within a few days, please @-mention one of teddylee777, musangk, BAEM1N

꼼꼼히 검수해주셔서 감사합니다. 아래 사항 반영하여 커밋합니다.

- pip install 부분에서 !를 %로 변경하였습니다.
- 가이드 주신 typo 부분들 반영하였습니다.
- 제목에 쓰인 백틱은 제거하였습니다.
@HarryKane11 HarryKane11 added the proofreading 번역/검수팀 제안사항 반영 label Jan 18, 2025
Q0211
Q0211 previously approved these changes Jan 19, 2025
@BokyungisaGod
Copy link
Contributor

BokyungisaGod commented Jan 19, 2025

안녕하세요 @HarryKane11 님:) 우선 수정해주신 부분은 모두 확인하였습니다. 추가적으로 몇군데만 더 수정해주시면 감사하겠습니다.
1.
스크린샷 2025-01-19 오후 1 01 14
별거 아니지만 ㅎㅎ Overview 쪽에 문장 끝에 . 을 찍어주시기 바랍니다.
ex) Load and parse web documents effectively.
Customize parsing behavior using BeautifulSoup options.
Handle different web content structures flexibly.
2.
스크린샷 2025-01-19 오후 1 03 14
References 아래에 ---- 처리를 해주시기 바랍니다.
ex)
스크린샷 2025-01-19 오후 1 04 13
3.
스크린샷 2025-01-19 오후 1 09 12
alazy_load()는 함수명같은데, 소제목에도 변수명/함수명/모듈명이 포함되어 있다면 backtick처리를 해주셔야 합니다.
4.
스크린샷 2025-01-19 오후 1 10 37
제가 틀렸을 수도 있는데, 1은 그냥 상수로 설정된 값 같습니다. 상수는 backtick처리를 하지 않아도 됩니다. 검토 후 의견 주시면 감사하겠습니다.
5.
스크린샷 2025-01-19 오후 1 14 46
loader도 변수명같은데, 의견 주시면 감사하겠습니다. 변수몀이 맞다면 backtick처리 해주세요.
6.
스크린샷 2025-01-19 오후 1 17 52
ProxyError 랑 AuthenticationError는 Python의 requests.exceptions 모듈에 정의된 클래스 아닌가싶은데 bold처리를 하는 것이 맞는 것 같습니다. 이 부분도 확인 후 의견주세요.
+) bold처리를 할 때는 뒤에 space를 한 칸 띄워줘야 합니다! ex. *ProxyErrorAuthenticationError may occur.
7.
스크린샷 2025-01-19 오후 1 19 56

Simple Web Content Loading with MarkItDown

Unlike WebBaseLoader which uses BeautifulSoup4 for sophisticated HTML parsing, MarkItDown provides a naive but simpler approach to web content loading. ~

Below is a basic example of loading web content using MarkItDown:
제가 생각하는 backtick이 필요한 부분에 대해 표시를 해놨는데요, 이 또한 검토 후 의견 부탁드립니다.
8.
스크린샷 2025-01-19 오후 12 58 51
맨 마지막에 빈 코드 칸이 하나가 추가되어있던데, 삭제 바랍니다.

+) 현재 저희 팀원의 검수 내용과 제가 따로 검수해본 결과 마크다운 문법(특히 backtick)을 거의 고려하지 않으신 것 같습니다.. 저희 검수팀은 개발을 꾸준히 하시던 분들로 구성되어있지 않은지라 개발을 하시는 분들과 비교했을 때, 변수, 함수, 모듈명이 헷갈리는 부분 많습니다. 특히, 모듈명과 라이브러리 명에서요. 물론 번역/검수팀에서 최대한 꼼꼼히 검수하고, 수정해야 할 부분들을 찾아 feedback을 드리는 것이 가장 이상적인 것은 알고 있습니다. 하지만, 이제 3주차가 지나가는 시점에 markdown 문법같은건 특히 조금 더 신경써서 내용을 작성해주셨으면 합니다! (함수/변수/모듈명 관련한 내용은 개발하신 분들이 저희보다 훨씬 더 잘 아실 것 같다는 생각이 들어요ㅜㅜ.) 부탁드립니다:)

@HarryKane11
Copy link
Contributor Author

안녕하세요 @BokyungisaGod 보경님! 우선 검수팀에서 많은 문서를 검수하시느라 고생하시는거 잘 알고, 제 문서에 틀린 부분이 많아 번거로웠을 심정 이해하고 죄송하다는 말씀 드립니다.

제가 backtick 관련 부분에서 오류가 많아보이는건, 디스코드 상에서 히스토리 따라가면서 확인하다가, 제목에서는 backtick을 안해도 되지 않나 하는 의견(가이드-PPT 마스터 가이드 1월 17일자에 백틱 관련 규칙 정리하신다는 글)을 보고 그렇게 고쳤었습니다. 제목에도 변수명이면 backtick을 쓰는 것은 이미 컨센서스 된 부분이라면 충분히 Follow-up하지 못한 것 같네요... 주의하겠습니다.

아래 번호별로 의견 드립니다.

  1. 마침표 반영하겠습니다.
  2. References 아래에 ---- 처리 반영하겠습니다.
  3. alazy_load() 소제목에도 backtick 처리하겠습니다.
  4. 네, 1도 그냥 상수로 취급하고 backtick 풀겠습니다.
  5. loader도 변수명같은데, 의견 주시면 감사하겠습니다. --> 변수명이 아니라 설명 상 들어간 단어라서, backtick 처리 안하겠습니다.
  6. ProxyError 랑 AuthenticationError는 bold 처리 하겠습니다.
  7. 마지막 섹션의 backtick 필요한 부분 반영하겠습니다.
  8. 맨 마지막에 빈 코드 칸 삭제하겠습니다.

HarryKane11 and others added 4 commits January 19, 2025 15:09
- 마크다운 문법 적용 안된 부분이나 잘못 처리된 부분 Fix
- 튜토리얼 링크가 삭제되어 있어서 다시 추가했습니다.
@BokyungisaGod
Copy link
Contributor

넵넵 의견 반영 감사합니다!! (참고: 소제목의 경우도 앞으로 backtick처리 할 것 같아요!)

Copy link
Contributor

@BokyungisaGod BokyungisaGod left a comment

Choose a reason for hiding this comment

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

수고하셨습니다:)

@teddylee777 teddylee777 merged commit 5856175 into LangChain-OpenTutorial:main Jan 20, 2025
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proofreading 번역/검수팀 제안사항 반영
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Proofread: < 06-DocumentLoader / 03-WebBaseLoader.ipynb >
4 participants