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 command refinements #538

Closed
Numerlor opened this issue Oct 15, 2019 · 4 comments · Fixed by #546
Closed

Docs command refinements #538

Numerlor opened this issue Oct 15, 2019 · 4 comments · Fixed by #546
Assignees
Labels
a: frontend Related to output and formatting p: 3 - low Low Priority s: WIP Work In Progress

Comments

@Numerlor
Copy link
Contributor

With how the symbols are currently loaded to the inventories dict, earlier entries get overwritten by newer ones.
This can have negative impact, most notably when loading the 2to3 tool which overrides things like print, zip or input and returns mostly useless docs to them.
It could be solved by never overwriting existing dict entries, or by defining a list of modules that won't override existing dict entries, to keep cases where it's better to not do it (object as an example)

Second issue is how the parsing is handled when a module is fetched from the docs.
The whole page, also containing the module functions, gets parsed into the signature which is put into a codeblock without any newlines between paragraphs, making it hard to read.

@atmishra
Copy link
Contributor

I would like to work on this.

@Numerlor
Copy link
Contributor Author

Numerlor commented Oct 16, 2019 via email

@scragly scragly added a: frontend Related to output and formatting meta: assigned p: 3 - low Low Priority s: WIP Work In Progress labels Oct 16, 2019
@scragly
Copy link
Contributor

scragly commented Oct 16, 2019

Sounds good to me, feel free to start work on it @Numerlor

@Numerlor
Copy link
Contributor Author

If I were to use the list of symbols/doc module names to specify which can overwrite and which cannot, where should I put it? Skimming through it, it looks like a dozen or so will be needed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a: frontend Related to output and formatting p: 3 - low Low Priority s: WIP Work In Progress
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants