Fix duplicate names of `Pylint Messages` in docs #5744

DanielNoord · 2022-01-29T16:08:45Z

Add yourself to CONTRIBUTORS if you are a new contributor.
Write a good description on what the PR does.

Type of Changes

	Type
✓	🐛 Bug fix
✓	📜 Docs

Description

Pretty stupid to have missed this. Should be merged asap to help SEO.

Closes #5740.

coveralls · 2022-01-29T16:16:00Z

Pull Request Test Coverage Report for Build 1808554416

0 of 0 changed or added relevant lines in 0 files are covered.
2 unchanged lines in 1 file lost coverage.
Overall coverage decreased (-0.01%) to 93.923%

Files with Coverage Reduction	New Missed Lines	%
pylint/lint/parallel.py	2	92.86%

Totals
Change from base Build 1806840834:	-0.01%
Covered Lines:	14852
Relevant Lines:	15813

💛 - Coveralls

DanielNoord · 2022-01-29T16:16:58Z

@Pierre-Sassoulas What are the titles of the pages in the side bar for you? For me the seconde title doesn't seem to be updated..

Pierre-Sassoulas · 2022-01-29T18:38:39Z

For me the second title doesn't seem to be updated.

Same here. It's strange, although it would work as it is it look like there's no page containing "Overview" in the generated code : https://pylint--5744.org.readthedocs.build/en/5744/search.html?q=Overview

DanielNoord · 2022-01-29T18:39:17Z

Hmm, I'll have a look at this later.

Pierre-Sassoulas

Maybe a bug in readthedoc for this MR ? We can merge anyway as "pylint messages" makes sense for Overview of all Pylint messages ?

DanielNoord · 2022-01-29T18:40:57Z

Maybe a bug in readthedoc for this MR ? We can merge anyway as "pylint messages" makes sense for Overview of all Pylint messages ?

That would be strange.. I'd say let's wait to find the cause of the issue before merging.

…duplicate-names

DanielNoord · 2022-01-29T21:28:17Z

Fixed. Stupid mistake... The page was actually auto-generated, so changing the title in the file does nothing 😓

Pierre-Sassoulas · 2022-01-29T21:39:29Z

The page was actually auto-generated,

Should we had warning as comment at the beginning of the file ? Or maybe check that the file is up to date.

DanielNoord · 2022-01-29T21:40:50Z

I don't think we should check for it being up to date, that would mean every change to a message would add changes to the file. Which would inflate commit sizes unnecessarily. I'll add a comment though!

Pierre-Sassoulas · 2022-01-29T21:49:33Z

I don't think we should check for it being up to date,

Could you add a release stage in tbump to make sure it's up to date at release time then ? (See https://github.com/PyCQA/pylint/blob/main/tbump.toml#L31)

DanielNoord · 2022-01-29T21:51:46Z

I don't think we should check for it being up to date,

Could you add a release stage in tbump to make sure it's up to date at release time then ?

Do we want it to be? (I have no experience with tbump so no idea how to implement this).

Pierre-Sassoulas · 2022-01-29T22:12:01Z

Do we want it to be?

I think it's better if it's not too far from the current state of the code. Another positive things is that the diff is a nice summary of what message appeared between two releases.

I have no experience with tbumb

I made the change myself let me know what you think.

DanielNoord

Makes sense! Thanks for your help!

DanielNoord · 2022-01-29T22:16:26Z

doc/exts/pylint_messages.py

@@ -122,7 +122,10 @@ def _write_messages_list_page(
        stream.write(
            f""".. _messages-list:

-{get_rst_title("Pylint Messages", "=")}
+.. NOTE: This file is auto-generated. Make any changes to the associated
+.. docs extension in '{__name__}.py'.


DanielNoord · 2022-01-29T22:18:10Z

Build is failing though :( Do you see what's wrong?

Pierre-Sassoulas · 2022-01-29T22:25:30Z

Build is failing though

Hurgh, sorry it was working locally. It sounds like the problem is doc/messages/messages_introduction.rst:15: WARNING: Failed to create a cross reference. A title or caption not found: messages-list I dont know what I changed the broke that. I'm going to check that tomorrow.

DanielNoord · 2022-02-03T20:27:34Z

@Pierre-Sassoulas Have you had the time to look at this? We should probably try and merge this soon. I can also take a look?

Pierre-Sassoulas · 2022-02-03T21:15:54Z

I have no idea right now, and I have a busy week.

What I tried :

tox -e docs (work perfectly locally)
trying to launch manually (also works)
Changing the comment syntax near the reference (did not work)

What I thought about doing next:

Bisection of the change in github actions to see what is causing the problem exactly (but it's not elegant)

Ideas welcomed :)

…duplicate-names

Pierre-Sassoulas · 2022-02-07T22:35:35Z

Damn, it was this 'simple' in the end. Thank you for the debug work @DanielNoord, I'm under the water right now and appreciate that.

DanielNoord · 2022-02-07T22:41:08Z

Same, this was an easy fix I could do in between jobs 😄

Fix duplicate names of Pylint Messages in docs

3b71dd4

DanielNoord added the High priority Issue with more than 10 reactions label Jan 29, 2022

DanielNoord added this to the 2.13.0 milestone Jan 29, 2022

DanielNoord requested a review from Pierre-Sassoulas January 29, 2022 16:08

DanielNoord added the Documentation 📗 label Jan 29, 2022

Pierre-Sassoulas reviewed Jan 29, 2022

View reviewed changes

DanielNoord added 2 commits January 29, 2022 22:20

Merge branch 'main' of https://github.com/PyCQA/pylint into messages-…

30f358c

…duplicate-names

Fix stupid mistake

6975db8

Add comment

1f52e09

Pierre-Sassoulas added 2 commits January 29, 2022 23:06

Add the comment in the generation

47bfa04

Add tbump step to upgrade the placeholder markdown

e05c2ee

DanielNoord commented Jan 29, 2022

View reviewed changes

Pierre-Sassoulas added 2 commits January 30, 2022 10:21

Better rst comment syntax ?

356575d

Better rst comment syntax ?

527f952

Merge branch 'main' of https://github.com/PyCQA/pylint into messages-…

df816c5

…duplicate-names

DanielNoord added 5 commits February 7, 2022 20:33

Test

733c475

Test

7cd973e

Testy test

45e7cc3

Test 312134

d5f5128

Fix document

63b613a

DanielNoord requested a review from Pierre-Sassoulas February 7, 2022 19:59

Pierre-Sassoulas merged commit 533e6b8 into pylint-dev:main Feb 7, 2022

DanielNoord deleted the messages-duplicate-names branch February 7, 2022 22:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix duplicate names of `Pylint Messages` in docs #5744

Fix duplicate names of `Pylint Messages` in docs #5744

DanielNoord commented Jan 29, 2022

coveralls commented Jan 29, 2022 •

edited

Loading

DanielNoord commented Jan 29, 2022

Pierre-Sassoulas commented Jan 29, 2022

DanielNoord commented Jan 29, 2022

Pierre-Sassoulas left a comment

DanielNoord commented Jan 29, 2022

DanielNoord commented Jan 29, 2022

Pierre-Sassoulas commented Jan 29, 2022 •

edited

Loading

DanielNoord commented Jan 29, 2022

Pierre-Sassoulas commented Jan 29, 2022 •

edited

Loading

DanielNoord commented Jan 29, 2022

Pierre-Sassoulas commented Jan 29, 2022

DanielNoord left a comment

DanielNoord Jan 29, 2022

DanielNoord commented Jan 29, 2022

Pierre-Sassoulas commented Jan 29, 2022

DanielNoord commented Feb 3, 2022

Pierre-Sassoulas commented Feb 3, 2022

Pierre-Sassoulas commented Feb 7, 2022

DanielNoord commented Feb 7, 2022

Fix duplicate names of Pylint Messages in docs #5744

Fix duplicate names of Pylint Messages in docs #5744

Conversation

DanielNoord commented Jan 29, 2022

Type of Changes

Description

coveralls commented Jan 29, 2022 • edited Loading

Pull Request Test Coverage Report for Build 1808554416

💛 - Coveralls

DanielNoord commented Jan 29, 2022

Pierre-Sassoulas commented Jan 29, 2022

DanielNoord commented Jan 29, 2022

Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

DanielNoord commented Jan 29, 2022

DanielNoord commented Jan 29, 2022

Pierre-Sassoulas commented Jan 29, 2022 • edited Loading

DanielNoord commented Jan 29, 2022

Pierre-Sassoulas commented Jan 29, 2022 • edited Loading

DanielNoord commented Jan 29, 2022

Pierre-Sassoulas commented Jan 29, 2022

DanielNoord left a comment

Choose a reason for hiding this comment

DanielNoord Jan 29, 2022

Choose a reason for hiding this comment

DanielNoord commented Jan 29, 2022

Pierre-Sassoulas commented Jan 29, 2022

DanielNoord commented Feb 3, 2022

Pierre-Sassoulas commented Feb 3, 2022

Pierre-Sassoulas commented Feb 7, 2022

DanielNoord commented Feb 7, 2022

Fix duplicate names of `Pylint Messages` in docs #5744

Fix duplicate names of `Pylint Messages` in docs #5744

coveralls commented Jan 29, 2022 •

edited

Loading

Pierre-Sassoulas commented Jan 29, 2022 •

edited

Loading

Pierre-Sassoulas commented Jan 29, 2022 •

edited

Loading