-
Notifications
You must be signed in to change notification settings - Fork 87
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
docs: susa 함수에 jsdoc을 추가합니다. #250
Conversation
🦋 Changeset detectedLatest commit: 56e8705 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Co-authored-by: Bosung Baek <78058734+BO-LIKE-CHICKEN@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
고민되는 지점을 공유해요!
* | ||
* @see https://es-hangul.slash.page/docs/api/susa | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@BO-LIKE-CHICKEN 안녕하세요, 고민되는 지점이 있어서 멘션드리게 되었어요
제가 수사랑 수관형사가 뭔지 잘 몰라서, 결국 수사가 뭔지 수관형사가 무엇인지 검색해볼 것 같다는 생각이 들더라구요
@see 수사? https://ko.dict.naver.com/#/entry/koko/d0ce2b674cae4b44b9028f648dd458b0
이런 링크도 첨부하는 것이 좋을지 고민됩니다!
cc @okinawaa
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
링크를 제공해주는 것은 너무 좋은 친절함 같지만, 링크를 전달하는 방식에서 이런 아이디어를 제안드려요 🙇🏻♂️
- @see 태그에서는 es-hangul에서 제공하는 docs로의 링크만 제공하는 것이 좋을 것 같아요
- "한글"이라는 복잡한 도메인의 특성상 앞으로도 "한국인도 어려운 도메인 지식"을 만나게 될텐데 다음과 같은 방식으로 제공해주면 어떨까해요
이렇게 제공하게되면 어려운 한글 도메인에 대한 설명 뿐만 아니라 의문을 가질 수 있는 함수의 제한(왜 1~100 까지만 지원하지?)에 대해서도 설명해 줄 수 있을 것 같아요 🙂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
감사합니다 !!! 너무 좋네요!!! 🙇
Co-authored-by: Bosung Baek <78058734+BO-LIKE-CHICKEN@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
두분 너무 값진 논의 후 구현까지 진행해주셔서 감사합니다! 🙇
Overview
susa에 jsdoc을 추가합니다.
#201 (comment) 에서 논의된 내용을 바탕으로 만들어졌어요.
Special Thanks to @BO-LIKE-CHICKEN
PR Checklist