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

feat: docs linter improvements #2404

Merged
merged 14 commits into from
Jun 21, 2024
Merged

Conversation

leohhhn
Copy link
Contributor

@leohhhn leohhhn commented Jun 20, 2024

Description

This PR improves the recently merged docs linter. It adds checks for improperly escaped JSX tags, and makes the addition of further linter checks easier with better pipelining.

It also implements a change to the gnoclient docs by introducing godoc, as well as a few minor fixes.

Contributors' checklist...
  • Added new tests, or not needed, or not feasible
  • Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
  • Updated the official documentation or not needed
  • No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
  • Added references to related issues and PRs
  • Provided any useful hints for running manual tests
  • Added new benchmarks to generated graphs, if any. More info here.

Copy link

codecov bot commented Jun 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.70%. Comparing base (ea1ff3f) to head (edbc349).

Additional details and impacted files
@@           Coverage Diff            @@
##           master    #2404    +/-   ##
========================================
  Coverage   54.69%   54.70%            
========================================
  Files         582      582            
  Lines       78430    78293   -137     
========================================
- Hits        42899    42829    -70     
+ Misses      32319    32258    -61     
+ Partials     3212     3206     -6     
Flag Coverage Δ
misc/autocounterd 0.00% <ø> (ø)
misc/genproto 0.00% <ø> (ø)
misc/genstd 73.90% <ø> (ø)
misc/goscan 0.00% <ø> (ø)
misc/logos 17.38% <ø> (ø)
misc/loop 0.00% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@leohhhn leohhhn marked this pull request as ready for review June 20, 2024 20:03
@leohhhn leohhhn requested review from a team and moul as code owners June 20, 2024 20:03
@leohhhn leohhhn requested review from petar-dambovaliev and removed request for a team June 20, 2024 20:03
Copy link
Member

@moul moul left a comment

Choose a reason for hiding this comment

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

LGTM

@leohhhn leohhhn merged commit 31a5f2e into gnolang:master Jun 21, 2024
19 of 26 checks passed
@leohhhn leohhhn deleted the docs/linter-improvements branch June 21, 2024 17:00
gfanton pushed a commit to gfanton/gno that referenced this pull request Jul 23, 2024
<!-- please provide a detailed description of the changes made in this
pull request. -->

## Description

This PR improves the recently merged docs linter. It adds checks for
improperly escaped JSX tags, and makes the addition of further linter
checks easier with better pipelining.

It also implements a change to the gnoclient docs by introducing godoc,
as well as a few minor fixes.


<details><summary>Contributors' checklist...</summary>

- [x] Added new tests, or not needed, or not feasible
- [x] Provided an example (e.g. screenshot) to aid review or the PR is
self-explanatory
- [x] Updated the official documentation or not needed
- [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message
was included in the description
- [x] Added references to related issues and PRs
- [x] Provided any useful hints for running manual tests
- [x] Added new benchmarks to [generated
graphs](https://gnoland.github.io/benchmarks), if any. More info
[here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md).
</details>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants