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

doc: linting error on docs/api/http.md #37759

Closed
1 task
danielleadams opened this issue Mar 15, 2021 · 5 comments
Closed
1 task

doc: linting error on docs/api/http.md #37759

danielleadams opened this issue Mar 15, 2021 · 5 comments
Labels
doc Issues and PRs related to the documentations.

Comments

@danielleadams
Copy link
Member

danielleadams commented Mar 15, 2021

📗 API Reference Docs Problem

  • Version: master branch
  • Platform: Darwin Kernel Version 19.6.0; root:xnu-6153.141.16~1/RELEASE_X86_64 x86_64
  • Subsystem: http

Location

Affected URL(s):

specific to running make test and make test-doc

Description

Running the test scripts and linter on master is producing a linter warning that is blocking the test scripts from completing successfully. It points to this line: 53b673e#diff-d692ac4524379ec6a1201165e8ff8d3267c8130e07014e8221ebf7e6f80c6641R3144.

The error message received is:

doc/api/http.md
  3119:1-3119:41  warning  Found unused definition  no-unused-definitions  remark-lint

⚠ 1 warning
make: *** [tools/.mdlintstamp] Error 1

I believe it's related to #37265, but I wasn't able to come up with a fix.


  • I would like to work on this issue and
    submit a pull request.
@danielleadams danielleadams added the doc Issues and PRs related to the documentations. label Mar 15, 2021
@aduh95
Copy link
Contributor

aduh95 commented Mar 15, 2021

I'm not able to reproduce, what commit are you at?

@danielleadams
Copy link
Member Author

I was seeing it when I cherry-picked the PR's commit onto the v15.x-staging branch. On my local branch, HEAD is at b0f4766207b5b227bd4698c3488bee5677256a12

@lpinca
Copy link
Member

lpinca commented Mar 16, 2021

I also can't reproduce. Did you try running make doclean first?

@aduh95
Copy link
Contributor

aduh95 commented Mar 16, 2021

@danielleadams Thanks, I'm able to reproduce on v15.x-staging. I think you need to either backport #33768 and #36917 before #37265 or remove the message.socket reference (line 3119) when fixing the git conflict.

@danielleadams
Copy link
Member Author

Thanks @aduh - I'll remove the message.socket from the conflict. Going to close this since it doesn't show up in master

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

No branches or pull requests

3 participants