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

docs: improve documentation and align indentation #793

Merged
merged 4 commits into from
Nov 20, 2024

Conversation

ririnto
Copy link
Contributor

@ririnto ririnto commented Nov 17, 2024

Motivation

  • improve documentation and align indentation

Modifications

  • docs/ko/jpql-with-kotlin-jdsl/migration-2.x-to-3.x.md: Removed trailing whitespace characters
  • docs/ko/jpql-with-kotlin-jdsl/predicates.md: Fixed typos
    • Before: 떄문에
    • After: 때문에
  • docs/ko/jpql-with-kotlin-jdsl/predicates.md: Improved sentences
    • Before: 사용할 함수의 정보를 JPA 제공자에 등록할 필요가 있을 수 있습니다.
    • After: 사용하려는 함수에 대한 정보를 JPA Provider에 등록해야 할 수도 있습니다.
  • docs/en/SUMMARY.md, docs/ko/SUMMARY.md: Adjusted indentation to match .editorconfig settings

Commit Convention Rule

Commit type Description
feat New Feature
fix Fix bug
docs Documentation only changed
ci Change CI configuration
refactor Not a bug fix or add feature, just refactoring code
test Add Test case or fix wrong test case
style Only change the code style(ex. white-space, formatting)
chore It refers to minor tasks such as library version upgrade, typo correction, etc.
  • If you want to add some more commit type please describe it on the Pull Request

Result

  • Fixed typos and improved documentation readability
  • Maintained consistent style according to .editorconfig

@CLAassistant
Copy link

CLAassistant commented Nov 17, 2024

CLA assistant check
All committers have signed the CLA.

@ririnto
Copy link
Contributor Author

ririnto commented Nov 17, 2024

변경은 각각의 커밋으로 이루어져있으니, 거부되는 변경이 있는 경우 drop하시면 됩니다.


아래는 문서화에 대한 건의 내용입니다.

현재 md의 max_line_length가 300으로 지정되어 있는데, 해당 길이는 너무 길게 보여집니다. 해당 값을 120으로 변경하는 것은 어떤가요?

  • 단일 줄바꿈은 md 생성 이후 단일 공백으로 나타나니 해당 부분을 이용하시면 여러 줄에 걸치면서도 문서에서는 단일 라인으로 표시되도록 할 수 있습니다.
  • docs: improve wording for clarity 커밋의 수정처럼 문서 사이에 줄바꿈이 있어야 자연스러워 보일 항목들에는 줄바꿈을 추가하는 것이 어떨까요?

위 내용에 대해 논의가 필요하다면 issue로 추가하겠습니다.

@shouwn shouwn merged commit 922eac6 into line:main Nov 20, 2024
4 checks passed
@shouwn
Copy link
Member

shouwn commented Nov 20, 2024

@ririnto 안녕하세요. 도움을 주셔서 감사합니다! 먼저 PR로 작성해주신 내용은 머지했습니다.

말씀주신 건의 내용은 별도의 Issue로 등록 부탁드립니다. 거기서 논의하는 것이 여러 사람들이 볼 수 있을 것 같기 때문입니다.

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.

4 participants