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: docs パッケージのソースコードにドキュメントを追加 #1109

Merged
merged 2 commits into from
Oct 4, 2023

Conversation

MikuroXina
Copy link
Collaborator

close #1073

Type of Change:

ドキュメントの追加

Details of implementation (実施内容)

src/ にディレクトリ構成を表す README.md を追加しました. そして各コンポーネントに TSDoc 形式のドキュメントコメントを追記しました.

@MikuroXina MikuroXina requested a review from m1sk9 October 4, 2023 00:37
@MikuroXina MikuroXina self-assigned this Oct 4, 2023
@github-actions github-actions bot added the T-@oreorebot2/docs Type: OreOreBot2 Docs (packages/docs) label Oct 4, 2023
@MikuroXina MikuroXina added C-development Category: development T-@oreorebot2/bot Type: OreOreBot2 Bot (packages/bot) and removed T-@oreorebot2/docs Type: OreOreBot2 Docs (packages/docs) T-@oreorebot2/bot Type: OreOreBot2 Bot (packages/bot) labels Oct 4, 2023
@cloudflare-workers-and-pages
Copy link

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: a1f6d8a
Status: ✅  Deploy successful!
Preview URL: https://3f8817ba.oreorebot2.pages.dev
Branch Preview URL: https://docs--1073.oreorebot2.pages.dev

View logs

@MikuroXina MikuroXina added the T-@oreorebot2/docs Type: OreOreBot2 Docs (packages/docs) label Oct 4, 2023
@codecov
Copy link

codecov bot commented Oct 4, 2023

Codecov Report

Merging #1109 (a1f6d8a) into main (3fffe8f) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1109   +/-   ##
=======================================
  Coverage   72.43%   72.43%           
=======================================
  Files          80       80           
  Lines        5464     5464           
  Branches      486      486           
=======================================
  Hits         3958     3958           
  Misses       1021     1021           
  Partials      485      485           
Flag Coverage Δ
unittests 72.43% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@MikuroXina MikuroXina enabled auto-merge (squash) October 4, 2023 00:41
@MikuroXina MikuroXina merged commit beeecd1 into main Oct 4, 2023
15 checks passed
@MikuroXina MikuroXina deleted the docs/#1073 branch October 4, 2023 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-development Category: development T-@oreorebot2/docs Type: OreOreBot2 Docs (packages/docs)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ドキュメントの各ディレクトリに説明を追加する
2 participants