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

Add Documentation for basm_std::math::factorize , Writer #94

Merged
merged 8 commits into from
Jun 15, 2024

Conversation

dodok8
Copy link
Contributor

@dodok8 dodok8 commented Jun 4, 2024

Close #93

현재 진행상황

  • basm_std::math::factorize
  • Writer

@dodok8 dodok8 changed the title Add Documentation Add Documentation for basm_std::math::factorize , Writer Jun 4, 2024
@byeongkeunahn
Copy link
Collaborator

꼼꼼한 문서화 감사합니다. 리뷰사항이 전체적이어서 코멘트로 달겠습니다.

  • 영어로 메서드를 설명할 때는 3인칭 단수 현재형으로 작성해주세요.
  • BOJ에 관한 내용은 추가할 수도 있지만 basm-rs 자체는 Baekjoon Online Judge (BOJ) 이외의 채점환경에도 제출 가능하도록 설계되어 있으므로 제거하면 어떨까 싶습니다. 사용자가 basm을 사용하여 BOJ 등에 제출할 때는 반드시 직접 target architecture를 선택하여 빌드하는 과정을 거치기 때문에 isize/usize의 크기에 대해서 이 시점에 인지하게 됩니다.
  • Write를 "어디로" 하는지 명시해주시면 좋을 것 같습니다. Write의 대상은 "표준 출력(stdout)"입니다.
  • basm-std/src/platform/io/writer.rs에 Line 122 오타, Line 146 ...safely use private method -> ...safely use "the" private method 등 문법을 확인해주세요.

quick review라 빠진 사항이 있을 수도 있습니다. contribution을 해주셔서 감사합니다.

@kiwiyou
Copy link
Collaborator

kiwiyou commented Jun 6, 2024

@dodok8

@dodok8
Copy link
Contributor Author

dodok8 commented Jun 6, 2024

확인했습니다! 곧 수정하겠습니다.

(6.9. 수정) 근무지 여건이 너무 바빠져서 수정이 늦어지고 있습니다 이번 달 안에는 처리하겠습니다. 그전에는 드래프트로 돌려놓겠습니다. 죄송합니다.

@byeongkeunahn byeongkeunahn marked this pull request as draft June 9, 2024 12:37
@dodok8
Copy link
Contributor Author

dodok8 commented Jun 15, 2024

수정했습니다.

@byeongkeunahn byeongkeunahn marked this pull request as ready for review June 15, 2024 10:02
@byeongkeunahn
Copy link
Collaborator

수정 감사합니다. 리뷰 후 코멘트 내용을 다시 수정했습니다. 새로 발생한 Clippy 이슈에 따른 수정도 있습니다. 혹시 수정사항에 이상한 부분 등이 있으면 자유롭게 의견 주세요 :)

@byeongkeunahn byeongkeunahn merged commit b5812be into boj-rs:main Jun 15, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

basm 문서화 프로젝트(basm_std::math::factorize, Writer)
3 participants