Wojtek Walczak schrieb: > Pauli Virtanen napisał(a): > >> But for the developer, clicking through the change suggestions via the >> Django-Bookish UI seems quite clumsy. From this POV, it would be useful >> to also have a report view where one could browse through all comments, >> filtered by the tags (eg. change suggestions, typo), and categorized by >> file. > > Fully agreed. I think that I have to look at every piece of this > project from two perspectives: (1) a person who only wants to read > the docs and (2) a developer, who wants to browse the comments > in most efficient way. > > The user should be allowed to read the docs without being too distracted > by the comments app, while the developer should have access to features > like easy browsing, sorting etc. > > I am even cosidering a switch like "User/Developer". If you are a user, > you would probably like to know if there is any comment, which extends > what has been said in particular paragraph. And if you're a developer, > you're rather searching for open / high priority issues. > > So, by default, everyone is a user, and has access to comments and is > able to add his own comments. In such case, user should be informed > if there are any comments interesting from his point of view (like, > someone decided to extend given block of text and it probably is more > important and interesting to an ordinary reader). > > But, when you switch to developer mode, you're changing perspective. > The app should help you deal with open issues. You should be able to > view all the comments for selected files and sort the comments by > priority, type or status, change type/priority, accept or reject > a comment and so on.
That all sounds very nice. >> * Also, a comment policy probably needs probably to be set: ensure that >> what the users submit in there can legally be incorporated as a part of >> the documentation itself... In the possible event that the submitted >> stuff is good. > > I am not sure that I get this point. Could you elaborate a bit more? The problem is that if a user submits something that is going to be committed, he must place it under the license of the project and/or assign the copyright for the contribution to the project, even if the contribution is trivial. Within Python, large contributions require sending a contributor agreement to the PSF, while smaller contributions are usually committed just mentioning the author, who is implicitly assumed to have transferred copyright. Georg --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~----------~----~----~----~------~----~------~--~---
