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: refactor lib/module document #136

Merged
merged 3 commits into from May 14, 2022
Merged

docs: refactor lib/module document #136

merged 3 commits into from May 14, 2022

Conversation

kazuk
Copy link
Contributor

@kazuk kazuk commented May 11, 2022

Issue number and link

Related Issue: #105

Describe your changes

crate / module documentation move to pure Markdown

crate documentation move to lib.md
module documentation move to [module_dir]/module.md

Checklist before requesting a review

  • I follow the Semantic Pull Requests rules (bugfix/feature)
  • I specified links to related issues (must: bugfix, want: feature)
  • I have performed a self-review of my code (bugfix/feature)
  • I have added thorough tests (bugfix/feature)
  • I have edited ## [Unreleased] section in CHANGELOG.md following keep a changelog syntax (bugfix/feature)
  • I {made/will make} a related pull request for documentation repo (feature)

 crate / module documentation move to pure Markdown

 crate documentation move to lib.md
 module documentation move to [module_dir]/module.md
@codecov
Copy link

codecov bot commented May 11, 2022

Codecov Report

Merging #136 (b3a6ec5) into main (3001bbc) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #136      +/-   ##
==========================================
+ Coverage   87.80%   87.82%   +0.01%     
==========================================
  Files         203      203              
  Lines       12620    12620              
==========================================
+ Hits        11081    11083       +2     
+ Misses       1539     1537       -2     
Impacted Files Coverage Δ
springql-core/src/expression.rs 75.44% <ø> (+1.19%) ⬆️
springql-core/src/lib.rs 100.00% <ø> (ø)
springql-core/src/pipeline.rs 92.30% <ø> (ø)
springql-core/src/stream_engine.rs 95.65% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3001bbc...b3a6ec5. Read the comment docs.

Copy link
Contributor

@laysakura laysakura left a comment

I like to use include_str! but have some requests.

springql-core/src/expression/module.md Outdated Show resolved Hide resolved
springql-core/src/expression.rs Outdated Show resolved Hide resolved
@laysakura laysakura marked this pull request as ready for review May 13, 2022
@laysakura laysakura marked this pull request as draft May 13, 2022
@laysakura
Copy link
Contributor

laysakura commented May 13, 2022

sorry, I mistakenly made it ready (so made it back to draft again).

kazuk added 2 commits May 14, 2022
 suppress MD041 markdown lint warning
 add suppress markdown lint MD024
@kazuk kazuk marked this pull request as ready for review May 14, 2022
@kazuk kazuk requested a review from laysakura May 14, 2022
Copy link
Contributor

@laysakura laysakura left a comment

👍

## [Unreleased]

### Changed

- Refactor : crate/module document move to pure Markdown ([#136](https://github.com/SpringQL/SpringQL/pull/136))
Copy link
Contributor

@laysakura laysakura May 14, 2022

Choose a reason for hiding this comment

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

[nits] I interpreted from "keep a changelog" and semantic versioning that Changed sections include "breaking changes", which bump up major versions.

But "keep a changelog" is a human readable format (not a machine readable one) and you noted Refactor:, it should be OK to add this line in CHANGELOG.

@laysakura laysakura merged commit 84de8fd into main May 14, 2022
13 of 15 checks passed
@laysakura laysakura deleted the docs_include_markdown branch May 14, 2022
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.

None yet

2 participants