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

Push documentation upstream #2

Open
phoe opened this issue May 18, 2020 · 2 comments
Open

Push documentation upstream #2

phoe opened this issue May 18, 2020 · 2 comments

Comments

@phoe
Copy link

phoe commented May 18, 2020

Some parent projects, such as Bordeaux Threads, could use documentation updates in their main repositories when it is complete.

@digikar99
Copy link
Member

For the most part, the documentation is taken from the docstrings. (alexandria and postmodern are an exception atm.) However, there does go much manual efforts in hyperlinking or formatting, due to either inconsistent formatting, or wanting to avoid hyperlink-cognitive-overload for the reader.

And let me clarify the title of this issue: you want the official documentation to be used here - is that the case?

@phoe
Copy link
Author

phoe commented May 18, 2020

Nope, I want the inverse - the official documentation is often out of date and could use efforts that update it, with BT being one example that I am aware of.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants