)]}'
{"/COMMIT_MSG":[{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"5829a63a069743a143b8cc99926dfbd19fb8d0ba","unresolved":true,"context_lines":[{"line_number":4,"context_line":"Commit:     Mahnoor Asghar \u003cmasghar.bese15seecs@seecs.edu.pk\u003e"},{"line_number":5,"context_line":"CommitDate: 2022-02-01 05:32:03 +0500"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"Create API documentation from docstrings"},{"line_number":8,"context_line":""},{"line_number":9,"context_line":"Create a new Sphinx extension called \u0027docstring\u0027 to process docstrings"},{"line_number":10,"context_line":"from the API classes, and generate API documentation."}],"source_content_type":"text/x-gerrit-commit-message","patch_set":1,"id":"8c909422_a670b999","line":7,"updated":"2022-02-04 17:48:10.000000000","message":"Most contributors, when trying to proof something out in CI, use a \"WIP\" label to denote status. So \"WIP: Create API...\"","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"3e1f6e89d5524cd23d63b65cc6c0e3dbd9ac6ffa","unresolved":false,"context_lines":[{"line_number":4,"context_line":"Commit:     Mahnoor Asghar \u003cmasghar.bese15seecs@seecs.edu.pk\u003e"},{"line_number":5,"context_line":"CommitDate: 2022-02-01 05:32:03 +0500"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"Create API documentation from docstrings"},{"line_number":8,"context_line":""},{"line_number":9,"context_line":"Create a new Sphinx extension called \u0027docstring\u0027 to process docstrings"},{"line_number":10,"context_line":"from the API classes, and generate API documentation."}],"source_content_type":"text/x-gerrit-commit-message","patch_set":1,"id":"ce121a0c_7bb21a45","line":7,"in_reply_to":"8c909422_a670b999","updated":"2022-02-08 18:05:53.000000000","message":"Makes sense! Noted. Thank you!","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"958e2d90db2288715221bb5a673c6a393d217c7f","unresolved":true,"context_lines":[{"line_number":4,"context_line":"Commit:     Mahnoor Asghar \u003cmasghar.bese15seecs@seecs.edu.pk\u003e"},{"line_number":5,"context_line":"CommitDate: 2022-03-12 01:32:52 +0500"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"[WIP] Create API documentation from docstrings"},{"line_number":8,"context_line":""},{"line_number":9,"context_line":"Create a new Sphinx extension called \u0027web_api_docstring\u0027 to process"},{"line_number":10,"context_line":"docstrings from the API classes, and generate API documentation."}],"source_content_type":"text/x-gerrit-commit-message","patch_set":12,"id":"11101f60_e2f9df36","line":7,"range":{"start_line":7,"start_character":0,"end_line":7,"end_character":6},"updated":"2022-03-15 16:32:56.000000000","message":"I think you can remove the WIP tag. :)","commit_id":"fd9f0a93748457a38d8124a4dee0159de0c51c68"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"a3d79f747b3be4314638351d89a9dc56ee8b4e55","unresolved":false,"context_lines":[{"line_number":4,"context_line":"Commit:     Mahnoor Asghar \u003cmasghar.bese15seecs@seecs.edu.pk\u003e"},{"line_number":5,"context_line":"CommitDate: 2022-03-12 01:32:52 +0500"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"[WIP] Create API documentation from docstrings"},{"line_number":8,"context_line":""},{"line_number":9,"context_line":"Create a new Sphinx extension called \u0027web_api_docstring\u0027 to process"},{"line_number":10,"context_line":"docstrings from the API classes, and generate API documentation."}],"source_content_type":"text/x-gerrit-commit-message","patch_set":12,"id":"517feeef_34c5bc41","line":7,"range":{"start_line":7,"start_character":0,"end_line":7,"end_character":6},"in_reply_to":"11101f60_e2f9df36","updated":"2022-03-16 20:24:39.000000000","message":"Done","commit_id":"fd9f0a93748457a38d8124a4dee0159de0c51c68"}],"/PATCHSET_LEVEL":[{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"3e1f6e89d5524cd23d63b65cc6c0e3dbd9ac6ffa","unresolved":false,"context_lines":[],"source_content_type":"","patch_set":2,"id":"5a3fd4e4_fbf36a28","updated":"2022-02-08 18:05:53.000000000","message":"Resolved previous comments. The parameters are now being generated from the docstrings.","commit_id":"8fa49892da6b195d2c14fca41819336cf64b7719"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"c95a417f986e767a2636a8a8e48789fbdc25c996","unresolved":false,"context_lines":[],"source_content_type":"","patch_set":5,"id":"d733fdc1_3ac90b71","updated":"2022-02-23 16:43:46.000000000","message":"Based upon discussion right now, I think https://github.com/openstack/ironic/blob/master/doc/requirements.txt is the file that needs to be changed in order to ensure the doc build works as expected.","commit_id":"d77ffa5fd90ced2efe4464836e48ce5cdcfff788"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"cf5757f463cd09826d5c3b8a056da2c6f1029206","unresolved":false,"context_lines":[],"source_content_type":"","patch_set":10,"id":"9eb1c795_acbc9423","updated":"2022-03-07 19:05:24.000000000","message":"So, overall I\u0027m impressed with the formatted output and the resulting documentation changes when using the extension. A few nitpicks inside. It would be helpful to understand how you envisioned the example json data to be maintained. From a post standpoint, it is much more \"practical\" documentation in my mind, but from a normal everyday developer standpoint it feels like duplication of existing examples. I guess I\u0027m also curious how you generated them upfront.\n\nOverall, the *main* item I would change is the note about classic drivers, since it no longer applies at all. Also, I don\u0027t quite understand the edit on the existing API ref? It might be necessary to put an inline internal note that is not rendered in there if it is for programmatic processing purposes.","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"42a833cf7df974cc7c7d66ad5d290eaa0e65cd13","unresolved":false,"context_lines":[],"source_content_type":"","patch_set":10,"id":"dd45265f_0e52a341","updated":"2022-03-08 20:25:13.000000000","message":"Thank you for the review! I have responded to the comments, and fixed some things in a new Patchset","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"42a833cf7df974cc7c7d66ad5d290eaa0e65cd13","unresolved":true,"context_lines":[],"source_content_type":"","patch_set":10,"id":"87a1279e_19495390","in_reply_to":"9eb1c795_acbc9423","updated":"2022-03-08 20:25:13.000000000","message":"Thank you for reviewing! I am glad you like the output :) I don\u0027t know how the example JSON requests and responses are currently being generated or maintained. \nI think they would need to be generated by the manual invocation of a script, perhaps, before they could be placed into the documentation.\nPerhaps that script could be invoked each time there is a new API version released.\nFor this patch, till now, I merely used the existing files in api-ref/source/samples, and tested their inclusion via docstrings. I copied them into doc/source/contributor/api/ to ensure \u0027tox -e docs\u0027 works.\n\nI have removed the classic driver references. I forgot to remove the API ref edit by mistake (was testing it out while programming). I have removed it now. :)","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"958e2d90db2288715221bb5a673c6a393d217c7f","unresolved":false,"context_lines":[],"source_content_type":"","patch_set":12,"id":"2759dbb8_7a84311a","updated":"2022-03-15 16:32:56.000000000","message":"A couple minor things and revise the doc strings and I think your almost there!","commit_id":"fd9f0a93748457a38d8124a4dee0159de0c51c68"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"a3d79f747b3be4314638351d89a9dc56ee8b4e55","unresolved":true,"context_lines":[],"source_content_type":"","patch_set":12,"id":"1f56d2d9_0f98cb9b","in_reply_to":"2759dbb8_7a84311a","updated":"2022-03-16 20:24:39.000000000","message":"Amended as per the comments :)","commit_id":"fd9f0a93748457a38d8124a4dee0159de0c51c68"},{"author":{"_account_id":15519,"name":"Iury Gregory Melo Ferreira","display_name":"Iury Gregory","email":"iurygregory@gmail.com","username":"iurygregory"},"change_message_id":"52eda5a25ac8c31ce1899be6b175f6d2254193c7","unresolved":false,"context_lines":[],"source_content_type":"","patch_set":15,"id":"534ed8ab_4428fbe7","updated":"2022-03-17 13:45:49.000000000","message":"Mahnoor, thank you very much, you did a great job! 🎉\nI really liked the new format and additions for our documentation.\nSteve has some comments but this can be future improvements \u003d)\n\n","commit_id":"3e631a5931c9a3d53d78438339adfeeae5fa5a70"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"d4a3949cc7120891af60c894d7769999471bf6d6","unresolved":true,"context_lines":[],"source_content_type":"","patch_set":15,"id":"b9e45a3c_5c290201","in_reply_to":"534ed8ab_4428fbe7","updated":"2022-03-17 20:17:00.000000000","message":"Thank you!","commit_id":"3e631a5931c9a3d53d78438339adfeeae5fa5a70"}],"api-ref/source/_ext/WebAPIDocstring.py":[{"author":{"_account_id":4571,"name":"Steve Baker","email":"sbaker@redhat.com","username":"steve-stevebaker"},"change_message_id":"a7b72fb0d9e199110c6bfd07e286ba3622f09150","unresolved":true,"context_lines":[{"line_number":24,"context_line":"from ironic.common import exception  # Application"},{"line_number":25,"context_line":""},{"line_number":26,"context_line":""},{"line_number":27,"context_line":"def readFromFile(fpath):"},{"line_number":28,"context_line":"    \"\"\"Read the data in file given by fpath.\"\"\""},{"line_number":29,"context_line":""},{"line_number":30,"context_line":"    with open(fpath, \u0027r\u0027) as stream:"}],"source_content_type":"text/x-python","patch_set":11,"id":"44b8edf3_66708c71","line":27,"range":{"start_line":27,"start_character":4,"end_line":27,"end_character":16},"updated":"2022-03-10 01:40:17.000000000","message":"It would be more pythonic for all of these function names to be lower-case with underscores, so read_from_file","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"9ad84fd659caed005b2fe3f965925f36ef00d91a","unresolved":false,"context_lines":[{"line_number":24,"context_line":"from ironic.common import exception  # Application"},{"line_number":25,"context_line":""},{"line_number":26,"context_line":""},{"line_number":27,"context_line":"def readFromFile(fpath):"},{"line_number":28,"context_line":"    \"\"\"Read the data in file given by fpath.\"\"\""},{"line_number":29,"context_line":""},{"line_number":30,"context_line":"    with open(fpath, \u0027r\u0027) as stream:"}],"source_content_type":"text/x-python","patch_set":11,"id":"e8cb6926_baa7ba06","line":27,"range":{"start_line":27,"start_character":4,"end_line":27,"end_character":16},"in_reply_to":"44b8edf3_66708c71","updated":"2022-03-11 15:40:43.000000000","message":"I have now updated the casing style in the whole file to be lowercase with underscores.","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"},{"author":{"_account_id":4571,"name":"Steve Baker","email":"sbaker@redhat.com","username":"steve-stevebaker"},"change_message_id":"a7b72fb0d9e199110c6bfd07e286ba3622f09150","unresolved":true,"context_lines":[{"line_number":32,"context_line":"        return yamlData"},{"line_number":33,"context_line":""},{"line_number":34,"context_line":""},{"line_number":35,"context_line":"def splitStrToField(inputStr):"},{"line_number":36,"context_line":"    \"\"\"Split the inputStr into 2 parts, the field name and field body."},{"line_number":37,"context_line":""},{"line_number":38,"context_line":"    The split is based on this regex format: :fieldName: fieldBody."}],"source_content_type":"text/x-python","patch_set":11,"id":"800a9a6c_5a4b076f","line":35,"updated":"2022-03-10 01:40:17.000000000","message":"This looks like its implementing a docstring parser. I think we can assume the docstrings are compliant reStructuredText as per PEP-287 [1]. This means it can be parsed with something like docutils.parsers.rst, so hopefully this extension can process parsed structured data instead of strings.\n\nI don\u0027t know how hard it will be to navigate docutils parsed docstrings. Here is one tutorial I found[2]\n\n[1] https://peps.python.org/pep-0287/\n[2] https://dzone.com/articles/a-brief-tutorial-on-parsing-restructuredtext-rest","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"242a1744d3deee7d2e6d8f7de1563c16f53c88a5","unresolved":true,"context_lines":[{"line_number":32,"context_line":"        return yamlData"},{"line_number":33,"context_line":""},{"line_number":34,"context_line":""},{"line_number":35,"context_line":"def splitStrToField(inputStr):"},{"line_number":36,"context_line":"    \"\"\"Split the inputStr into 2 parts, the field name and field body."},{"line_number":37,"context_line":""},{"line_number":38,"context_line":"    The split is based on this regex format: :fieldName: fieldBody."}],"source_content_type":"text/x-python","patch_set":11,"id":"d3884d94_8202ea3c","line":35,"in_reply_to":"800a9a6c_5a4b076f","updated":"2022-03-11 15:40:28.000000000","message":"So originally the included parsers in docutils were attempted, but they have some expectations on the data structure and handling which wouldn\u0027t quite work for the data handling. I think it was something about an expectation that exceptions only had one value or something along those lines.","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"d8e2a673044a442d678d45ecde0a6780cdc9bc9d","unresolved":true,"context_lines":[{"line_number":32,"context_line":"        return yamlData"},{"line_number":33,"context_line":""},{"line_number":34,"context_line":""},{"line_number":35,"context_line":"def splitStrToField(inputStr):"},{"line_number":36,"context_line":"    \"\"\"Split the inputStr into 2 parts, the field name and field body."},{"line_number":37,"context_line":""},{"line_number":38,"context_line":"    The split is based on this regex format: :fieldName: fieldBody."}],"source_content_type":"text/x-python","patch_set":11,"id":"47b1e523_f1b42be4","line":35,"in_reply_to":"d3884d94_8202ea3c","updated":"2022-03-11 16:22:08.000000000","message":"Because I was implementing a directive, I had to parse the string input directly. I have used docutils-based node objects that I return from the directive, and sphinx takes care of converting the node objects to the required implementation (html in our case) via writers.","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"}],"api-ref/source/_ext/docstring.py":[{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"5829a63a069743a143b8cc99926dfbd19fb8d0ba","unresolved":true,"context_lines":[{"line_number":1,"context_line":"from docutils import nodes"},{"line_number":2,"context_line":"from docutils.parsers.rst import Directive"},{"line_number":3,"context_line":"from docutils.core import publish_doctree"},{"line_number":4,"context_line":"import docutils"}],"source_content_type":"text/x-python","patch_set":1,"id":"9b274c2e_af35e68d","line":1,"in_reply_to":"13f09c0c_e6d6d93c","updated":"2022-02-04 17:48:10.000000000","message":"\u003e pep8: H102: Apache 2.0 license header not found\n\nPlease fix.","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"3e1f6e89d5524cd23d63b65cc6c0e3dbd9ac6ffa","unresolved":false,"context_lines":[{"line_number":1,"context_line":"from docutils import nodes"},{"line_number":2,"context_line":"from docutils.parsers.rst import Directive"},{"line_number":3,"context_line":"from docutils.core import publish_doctree"},{"line_number":4,"context_line":"import docutils"}],"source_content_type":"text/x-python","patch_set":1,"id":"e275659d_14cb364c","line":1,"in_reply_to":"9b274c2e_af35e68d","updated":"2022-02-08 18:05:53.000000000","message":"Done","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"5829a63a069743a143b8cc99926dfbd19fb8d0ba","unresolved":true,"context_lines":[{"line_number":1,"context_line":"from docutils import nodes"},{"line_number":2,"context_line":"from docutils.parsers.rst import Directive"},{"line_number":3,"context_line":"from docutils.core import publish_doctree"},{"line_number":4,"context_line":"import docutils"},{"line_number":5,"context_line":"from docutils.parsers.rst import Parser"},{"line_number":6,"context_line":"from docutils.utils import new_document"}],"source_content_type":"text/x-python","patch_set":1,"id":"a6237f97_8ef468db","line":3,"in_reply_to":"65c5e93c_3ae4c01b","updated":"2022-02-04 17:48:10.000000000","message":"\u003e pep8: F401 \u0027docutils.core.publish_doctree\u0027 imported but unused\n\nPlease fix.","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"3e1f6e89d5524cd23d63b65cc6c0e3dbd9ac6ffa","unresolved":false,"context_lines":[{"line_number":1,"context_line":"from docutils import nodes"},{"line_number":2,"context_line":"from docutils.parsers.rst import Directive"},{"line_number":3,"context_line":"from docutils.core import publish_doctree"},{"line_number":4,"context_line":"import docutils"},{"line_number":5,"context_line":"from docutils.parsers.rst import Parser"},{"line_number":6,"context_line":"from docutils.utils import new_document"}],"source_content_type":"text/x-python","patch_set":1,"id":"3665e96c_756454ae","line":3,"in_reply_to":"a6237f97_8ef468db","updated":"2022-02-08 18:05:53.000000000","message":"Done","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"5829a63a069743a143b8cc99926dfbd19fb8d0ba","unresolved":true,"context_lines":[{"line_number":1,"context_line":"from docutils import nodes"},{"line_number":2,"context_line":"from docutils.parsers.rst import Directive"},{"line_number":3,"context_line":"from docutils.core import publish_doctree"},{"line_number":4,"context_line":"import docutils"},{"line_number":5,"context_line":"from docutils.parsers.rst import Parser"},{"line_number":6,"context_line":"from docutils.utils import new_document"}],"source_content_type":"text/x-python","patch_set":1,"id":"e40c6ed2_8aea183c","line":3,"in_reply_to":"b222ddce_5105422f","updated":"2022-02-04 17:48:10.000000000","message":"\u003e pep8: H306: imports not in alphabetical order (docutils.parsers.rst.directive, docutils.core.publish_doctree)\n\nPlease fix.","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"3e1f6e89d5524cd23d63b65cc6c0e3dbd9ac6ffa","unresolved":false,"context_lines":[{"line_number":1,"context_line":"from docutils import nodes"},{"line_number":2,"context_line":"from docutils.parsers.rst import Directive"},{"line_number":3,"context_line":"from docutils.core import publish_doctree"},{"line_number":4,"context_line":"import docutils"},{"line_number":5,"context_line":"from docutils.parsers.rst import Parser"},{"line_number":6,"context_line":"from docutils.utils import new_document"}],"source_content_type":"text/x-python","patch_set":1,"id":"1a5cf8e5_3453976b","line":3,"in_reply_to":"e40c6ed2_8aea183c","updated":"2022-02-08 18:05:53.000000000","message":"Done","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"5829a63a069743a143b8cc99926dfbd19fb8d0ba","unresolved":true,"context_lines":[{"line_number":1,"context_line":"from docutils import nodes"},{"line_number":2,"context_line":"from docutils.parsers.rst import Directive"},{"line_number":3,"context_line":"from docutils.core import publish_doctree"},{"line_number":4,"context_line":"import docutils"},{"line_number":5,"context_line":"from docutils.parsers.rst import Parser"},{"line_number":6,"context_line":"from docutils.utils import new_document"},{"line_number":7,"context_line":"import docutils.parsers.rst.states"}],"source_content_type":"text/x-python","patch_set":1,"id":"e3736738_24782255","line":4,"in_reply_to":"05083ff3_e10c85fb","updated":"2022-02-04 17:48:10.000000000","message":"\u003e pep8: H306: imports not in alphabetical order (docutils.core.publish_doctree, docutils)\n\nPlease fix.","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"3e1f6e89d5524cd23d63b65cc6c0e3dbd9ac6ffa","unresolved":false,"context_lines":[{"line_number":1,"context_line":"from docutils import nodes"},{"line_number":2,"context_line":"from docutils.parsers.rst import Directive"},{"line_number":3,"context_line":"from docutils.core import publish_doctree"},{"line_number":4,"context_line":"import docutils"},{"line_number":5,"context_line":"from docutils.parsers.rst import Parser"},{"line_number":6,"context_line":"from docutils.utils import new_document"},{"line_number":7,"context_line":"import docutils.parsers.rst.states"}],"source_content_type":"text/x-python","patch_set":1,"id":"f55bc7eb_10d1a38d","line":4,"in_reply_to":"e3736738_24782255","updated":"2022-02-08 18:05:53.000000000","message":"Done","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"3e1f6e89d5524cd23d63b65cc6c0e3dbd9ac6ffa","unresolved":false,"context_lines":[{"line_number":2,"context_line":"from docutils.parsers.rst import Directive"},{"line_number":3,"context_line":"from docutils.core import publish_doctree"},{"line_number":4,"context_line":"import docutils"},{"line_number":5,"context_line":"from docutils.parsers.rst import Parser"},{"line_number":6,"context_line":"from docutils.utils import new_document"},{"line_number":7,"context_line":"import docutils.parsers.rst.states"},{"line_number":8,"context_line":"import re"}],"source_content_type":"text/x-python","patch_set":1,"id":"e698a229_168d9cf8","line":5,"in_reply_to":"78d16deb_7bd731e1","updated":"2022-02-08 18:05:53.000000000","message":"Done","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"5829a63a069743a143b8cc99926dfbd19fb8d0ba","unresolved":true,"context_lines":[{"line_number":2,"context_line":"from docutils.parsers.rst import Directive"},{"line_number":3,"context_line":"from docutils.core import publish_doctree"},{"line_number":4,"context_line":"import docutils"},{"line_number":5,"context_line":"from docutils.parsers.rst import Parser"},{"line_number":6,"context_line":"from docutils.utils import new_document"},{"line_number":7,"context_line":"import docutils.parsers.rst.states"},{"line_number":8,"context_line":"import re"}],"source_content_type":"text/x-python","patch_set":1,"id":"78d16deb_7bd731e1","line":5,"in_reply_to":"ec8a6c18_d77b8f23","updated":"2022-02-04 17:48:10.000000000","message":"\u003e pep8: F401 \u0027docutils.parsers.rst.Parser\u0027 imported but unused\n\nPlease fix.","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"5829a63a069743a143b8cc99926dfbd19fb8d0ba","unresolved":true,"context_lines":[{"line_number":11,"context_line":"from yaml.loader import SafeLoader"},{"line_number":12,"context_line":""},{"line_number":13,"context_line":""},{"line_number":14,"context_line":"class yamlParse:"},{"line_number":15,"context_line":"    def readFromFile(fpath):"},{"line_number":16,"context_line":"        with open(fpath, \u0027r\u0027) as stream:"},{"line_number":17,"context_line":"            yamlData \u003d yaml.load(stream, Loader\u003dyaml.SafeLoader)"}],"source_content_type":"text/x-python","patch_set":1,"id":"01320179_6c7efe40","line":14,"updated":"2022-02-04 17:48:10.000000000","message":"Generally, it is good to ensure that you can pass pep8 tests locally before uploading. `tox -epep8`\n\nYou can also run unit tests, but your working in an area that is not unit tested really.","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"3e1f6e89d5524cd23d63b65cc6c0e3dbd9ac6ffa","unresolved":false,"context_lines":[{"line_number":11,"context_line":"from yaml.loader import SafeLoader"},{"line_number":12,"context_line":""},{"line_number":13,"context_line":""},{"line_number":14,"context_line":"class yamlParse:"},{"line_number":15,"context_line":"    def readFromFile(fpath):"},{"line_number":16,"context_line":"        with open(fpath, \u0027r\u0027) as stream:"},{"line_number":17,"context_line":"            yamlData \u003d yaml.load(stream, Loader\u003dyaml.SafeLoader)"}],"source_content_type":"text/x-python","patch_set":1,"id":"b659a5ce_b72dae68","line":14,"in_reply_to":"01320179_6c7efe40","updated":"2022-02-08 18:05:53.000000000","message":"Thank you! Noted.","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"24013cba8e4afc2b42145bad4555fe1cb3559c61","unresolved":true,"context_lines":[{"line_number":176,"context_line":""},{"line_number":177,"context_line":"def processFailureList(failureList):"},{"line_number":178,"context_line":"    # Concatenate the field bodies split over multiple lines"},{"line_number":179,"context_line":"    for i in range(len(failureList) - 1):"},{"line_number":180,"context_line":"        # Attempt to split the next line into a field name and field body"},{"line_number":181,"context_line":"        nextFieldName, nextFieldBody \u003d parseStrToField(failureList[i + 1])"},{"line_number":182,"context_line":""}],"source_content_type":"text/x-python","patch_set":5,"id":"4f14e68b_602799a2","line":179,"range":{"start_line":179,"start_character":1,"end_line":179,"end_character":41},"updated":"2022-02-23 17:06:19.000000000","message":"A case to think of is what if failureList\u0027s value is 0.\n\nWhat will happen, what could fail.\n\nSame for a value of 1, and potentially 2.","commit_id":"d77ffa5fd90ced2efe4464836e48ce5cdcfff788"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"c90dc1c228c14aee8e1e201ebadf460d1371fb60","unresolved":false,"context_lines":[{"line_number":176,"context_line":""},{"line_number":177,"context_line":"def processFailureList(failureList):"},{"line_number":178,"context_line":"    # Concatenate the field bodies split over multiple lines"},{"line_number":179,"context_line":"    for i in range(len(failureList) - 1):"},{"line_number":180,"context_line":"        # Attempt to split the next line into a field name and field body"},{"line_number":181,"context_line":"        nextFieldName, nextFieldBody \u003d parseStrToField(failureList[i + 1])"},{"line_number":182,"context_line":""}],"source_content_type":"text/x-python","patch_set":5,"id":"3ccd21cd_98bd47c7","line":179,"range":{"start_line":179,"start_character":1,"end_line":179,"end_character":41},"in_reply_to":"4f14e68b_602799a2","updated":"2022-02-25 17:06:08.000000000","message":"I have now tried to do this using strings, and have tested with empty strings and an empty list","commit_id":"d77ffa5fd90ced2efe4464836e48ce5cdcfff788"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"24013cba8e4afc2b42145bad4555fe1cb3559c61","unresolved":true,"context_lines":[{"line_number":178,"context_line":"    # Concatenate the field bodies split over multiple lines"},{"line_number":179,"context_line":"    for i in range(len(failureList) - 1):"},{"line_number":180,"context_line":"        # Attempt to split the next line into a field name and field body"},{"line_number":181,"context_line":"        nextFieldName, nextFieldBody \u003d parseStrToField(failureList[i + 1])"},{"line_number":182,"context_line":""},{"line_number":183,"context_line":"        # If the next line does not contain a field name, but contains"},{"line_number":184,"context_line":"        # a string, it should be added to the current line\u0027s field body"},{"line_number":185,"context_line":"        if nextFieldName is None and nextFieldBody is not None:"},{"line_number":186,"context_line":"            if(failureList[i][-1] \u003d\u003d \u0027 \u0027):"},{"line_number":187,"context_line":"                failureList[i] \u003d failureList[i] + nextFieldBody"},{"line_number":188,"context_line":"            else:"},{"line_number":189,"context_line":"                failureList[i] \u003d failureList[i] + \u0027 \u0027 + nextFieldBody"},{"line_number":190,"context_line":"            # Remove content from next line, so it is not added to output"},{"line_number":191,"context_line":"            # incorrectly"},{"line_number":192,"context_line":"            failureList[i + 1] \u003d \u0027\u0027"}],"source_content_type":"text/x-python","patch_set":5,"id":"57b2b2ec_79a93b4e","line":189,"range":{"start_line":181,"start_character":0,"end_line":189,"end_character":69},"updated":"2022-02-23 17:06:19.000000000","message":"I would likely be mindful of IndexError. You likely want to use:\n\ntry:\n    array_action()\nexcept IndexError:\n    # everything okay!\n    pass\n\nOr something like it so your not looking at forward and past entries int he same array.","commit_id":"d77ffa5fd90ced2efe4464836e48ce5cdcfff788"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"c90dc1c228c14aee8e1e201ebadf460d1371fb60","unresolved":false,"context_lines":[{"line_number":178,"context_line":"    # Concatenate the field bodies split over multiple lines"},{"line_number":179,"context_line":"    for i in range(len(failureList) - 1):"},{"line_number":180,"context_line":"        # Attempt to split the next line into a field name and field body"},{"line_number":181,"context_line":"        nextFieldName, nextFieldBody \u003d parseStrToField(failureList[i + 1])"},{"line_number":182,"context_line":""},{"line_number":183,"context_line":"        # If the next line does not contain a field name, but contains"},{"line_number":184,"context_line":"        # a string, it should be added to the current line\u0027s field body"},{"line_number":185,"context_line":"        if nextFieldName is None and nextFieldBody is not None:"},{"line_number":186,"context_line":"            if(failureList[i][-1] \u003d\u003d \u0027 \u0027):"},{"line_number":187,"context_line":"                failureList[i] \u003d failureList[i] + nextFieldBody"},{"line_number":188,"context_line":"            else:"},{"line_number":189,"context_line":"                failureList[i] \u003d failureList[i] + \u0027 \u0027 + nextFieldBody"},{"line_number":190,"context_line":"            # Remove content from next line, so it is not added to output"},{"line_number":191,"context_line":"            # incorrectly"},{"line_number":192,"context_line":"            failureList[i + 1] \u003d \u0027\u0027"}],"source_content_type":"text/x-python","patch_set":5,"id":"2dc049cf_33b26070","line":189,"range":{"start_line":181,"start_character":0,"end_line":189,"end_character":69},"in_reply_to":"57b2b2ec_79a93b4e","updated":"2022-02-25 17:06:08.000000000","message":"I have now tried to do this using strings, instead of iterating over a list...","commit_id":"d77ffa5fd90ced2efe4464836e48ce5cdcfff788"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"24013cba8e4afc2b42145bad4555fe1cb3559c61","unresolved":true,"context_lines":[{"line_number":190,"context_line":"            # Remove content from next line, so it is not added to output"},{"line_number":191,"context_line":"            # incorrectly"},{"line_number":192,"context_line":"            failureList[i + 1] \u003d \u0027\u0027"},{"line_number":193,"context_line":"    return failureList"},{"line_number":194,"context_line":""},{"line_number":195,"context_line":""},{"line_number":196,"context_line":"def addExceptionDetails(failureList):"}],"source_content_type":"text/x-python","patch_set":5,"id":"be99d9f2_b88a7723","line":193,"range":{"start_line":193,"start_character":0,"end_line":193,"end_character":22},"updated":"2022-02-23 17:06:19.000000000","message":"Your editing failureList in place, which may be problematic. I would generate a new array and return it.","commit_id":"d77ffa5fd90ced2efe4464836e48ce5cdcfff788"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"c90dc1c228c14aee8e1e201ebadf460d1371fb60","unresolved":false,"context_lines":[{"line_number":190,"context_line":"            # Remove content from next line, so it is not added to output"},{"line_number":191,"context_line":"            # incorrectly"},{"line_number":192,"context_line":"            failureList[i + 1] \u003d \u0027\u0027"},{"line_number":193,"context_line":"    return failureList"},{"line_number":194,"context_line":""},{"line_number":195,"context_line":""},{"line_number":196,"context_line":"def addExceptionDetails(failureList):"}],"source_content_type":"text/x-python","patch_set":5,"id":"dbd6d6e5_a7e894a1","line":193,"range":{"start_line":193,"start_character":0,"end_line":193,"end_character":22},"in_reply_to":"be99d9f2_b88a7723","updated":"2022-02-25 17:06:08.000000000","message":"Thank you for pointing that out! Edited","commit_id":"d77ffa5fd90ced2efe4464836e48ce5cdcfff788"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"cf5757f463cd09826d5c3b8a056da2c6f1029206","unresolved":true,"context_lines":[{"line_number":1,"context_line":"# -*- coding: utf-8 -*-"},{"line_number":2,"context_line":"#"},{"line_number":3,"context_line":"# Licensed under the Apache License, Version 2.0 (the \"License\"); you may"},{"line_number":4,"context_line":"# not use this file except in compliance with the License. You may obtain"}],"source_content_type":"text/x-python","patch_set":10,"id":"0f8b1284_0db2a8ad","line":1,"updated":"2022-03-07 19:05:24.000000000","message":"FWIW, I would consider renaming the file from docstring to something a little more descriptive of the purpose/meaning of the file. Yes, it is doing some work with the docstrings, but we don\u0027t really understand what at all from the name since it is a bit broad.","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"42a833cf7df974cc7c7d66ad5d290eaa0e65cd13","unresolved":true,"context_lines":[{"line_number":1,"context_line":"# -*- coding: utf-8 -*-"},{"line_number":2,"context_line":"#"},{"line_number":3,"context_line":"# Licensed under the Apache License, Version 2.0 (the \"License\"); you may"},{"line_number":4,"context_line":"# not use this file except in compliance with the License. You may obtain"}],"source_content_type":"text/x-python","patch_set":10,"id":"0fc51905_7b987de4","line":1,"in_reply_to":"0f8b1284_0db2a8ad","updated":"2022-03-08 20:25:13.000000000","message":"Renamed to \u0027WebAPIDocstring\u0027. If anyone has other suggestions, please comment :)","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"cf5757f463cd09826d5c3b8a056da2c6f1029206","unresolved":true,"context_lines":[{"line_number":138,"context_line":"    return successList, failureList"},{"line_number":139,"context_line":""},{"line_number":140,"context_line":""},{"line_number":141,"context_line":"def processList(inputList):"},{"line_number":142,"context_line":"    outList \u003d []"},{"line_number":143,"context_line":""},{"line_number":144,"context_line":"    # Convert list to string"}],"source_content_type":"text/x-python","patch_set":10,"id":"22478b06_bdc11537","line":141,"updated":"2022-03-07 19:05:24.000000000","message":"It would be helpful, from a code maintenance standpoint, to maybe put a little bit of a docstring into some of these. What comes to mind is the regex invocation, and then returning a reformatted list. I guess what I\u0027m lacking is the purpose overall.","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"42a833cf7df974cc7c7d66ad5d290eaa0e65cd13","unresolved":true,"context_lines":[{"line_number":138,"context_line":"    return successList, failureList"},{"line_number":139,"context_line":""},{"line_number":140,"context_line":""},{"line_number":141,"context_line":"def processList(inputList):"},{"line_number":142,"context_line":"    outList \u003d []"},{"line_number":143,"context_line":""},{"line_number":144,"context_line":"    # Convert list to string"}],"source_content_type":"text/x-python","patch_set":10,"id":"302aa08b_9eea26b7","line":141,"in_reply_to":"22478b06_bdc11537","updated":"2022-03-08 20:25:13.000000000","message":"Makes a lot of sense. I have added docstrings to try to explain the purposes. ^-^","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"}],"api-ref/source/baremetal-api-v1-allocation.inc":[{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"5829a63a069743a143b8cc99926dfbd19fb8d0ba","unresolved":true,"context_lines":[{"line_number":8,"context_line":"deployment."},{"line_number":9,"context_line":""},{"line_number":10,"context_line":".. versionadded:: 1.52"},{"line_number":11,"context_line":"    Allocation API was introduced."},{"line_number":12,"context_line":""},{"line_number":13,"context_line":"Create Allocation"},{"line_number":14,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-c++src","patch_set":1,"id":"aac18702_06c110d3","side":"PARENT","line":11,"updated":"2022-02-04 17:48:10.000000000","message":"So outright deleting these files is likely not going to work, since they are presently required by the current api docs jobs.","commit_id":"365a4545fe6606b1fda8f1387e851641de25cec8"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"3e1f6e89d5524cd23d63b65cc6c0e3dbd9ac6ffa","unresolved":false,"context_lines":[{"line_number":8,"context_line":"deployment."},{"line_number":9,"context_line":""},{"line_number":10,"context_line":".. versionadded:: 1.52"},{"line_number":11,"context_line":"    Allocation API was introduced."},{"line_number":12,"context_line":""},{"line_number":13,"context_line":"Create Allocation"},{"line_number":14,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-c++src","patch_set":1,"id":"fe0a7e19_1dbb9a4a","side":"PARENT","line":11,"in_reply_to":"aac18702_06c110d3","updated":"2022-02-08 18:05:53.000000000","message":"Added back in.","commit_id":"365a4545fe6606b1fda8f1387e851641de25cec8"}],"api-ref/source/conf.py":[{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"5829a63a069743a143b8cc99926dfbd19fb8d0ba","unresolved":true,"context_lines":[{"line_number":33,"context_line":"}"},{"line_number":34,"context_line":""},{"line_number":35,"context_line":"extensions \u003d ["},{"line_number":36,"context_line":"    \u0027os_api_ref\u0027,"},{"line_number":37,"context_line":"    \u0027openstackdocstheme\u0027"},{"line_number":38,"context_line":"]"},{"line_number":39,"context_line":""}],"source_content_type":"text/x-python","patch_set":1,"id":"96312464_edab427b","side":"PARENT","line":36,"updated":"2022-02-04 17:48:10.000000000","message":"I would consider restoring this, since your heading in a slightly different direction for now and continuity is important.","commit_id":"365a4545fe6606b1fda8f1387e851641de25cec8"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"3e1f6e89d5524cd23d63b65cc6c0e3dbd9ac6ffa","unresolved":false,"context_lines":[{"line_number":33,"context_line":"}"},{"line_number":34,"context_line":""},{"line_number":35,"context_line":"extensions \u003d ["},{"line_number":36,"context_line":"    \u0027os_api_ref\u0027,"},{"line_number":37,"context_line":"    \u0027openstackdocstheme\u0027"},{"line_number":38,"context_line":"]"},{"line_number":39,"context_line":""}],"source_content_type":"text/x-python","patch_set":1,"id":"e3cf1f13_65c85a0c","side":"PARENT","line":36,"in_reply_to":"96312464_edab427b","updated":"2022-02-08 18:05:53.000000000","message":"Done in subsequent patchset.","commit_id":"365a4545fe6606b1fda8f1387e851641de25cec8"},{"author":{"_account_id":4571,"name":"Steve Baker","email":"sbaker@redhat.com","username":"steve-stevebaker"},"change_message_id":"a7b72fb0d9e199110c6bfd07e286ba3622f09150","unresolved":true,"context_lines":[{"line_number":36,"context_line":"    \u0027os_api_ref\u0027,"},{"line_number":37,"context_line":"    \u0027openstackdocstheme\u0027,"},{"line_number":38,"context_line":"    \u0027sphinx.ext.autodoc\u0027,"},{"line_number":39,"context_line":"    \u0027WebAPIDocstring\u0027"},{"line_number":40,"context_line":"]"},{"line_number":41,"context_line":""},{"line_number":42,"context_line":"openstackdocs_repo_name \u003d \u0027openstack/ironic\u0027"}],"source_content_type":"text/x-python","patch_set":11,"id":"935e52e0_6cb5fafb","line":39,"range":{"start_line":39,"start_character":5,"end_line":39,"end_character":20},"updated":"2022-03-10 01:40:17.000000000","message":"It would be more pythonic for this to be lower case with underscores, so the file could be web_api_docstring.py","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"9ad84fd659caed005b2fe3f965925f36ef00d91a","unresolved":false,"context_lines":[{"line_number":36,"context_line":"    \u0027os_api_ref\u0027,"},{"line_number":37,"context_line":"    \u0027openstackdocstheme\u0027,"},{"line_number":38,"context_line":"    \u0027sphinx.ext.autodoc\u0027,"},{"line_number":39,"context_line":"    \u0027WebAPIDocstring\u0027"},{"line_number":40,"context_line":"]"},{"line_number":41,"context_line":""},{"line_number":42,"context_line":"openstackdocs_repo_name \u003d \u0027openstack/ironic\u0027"}],"source_content_type":"text/x-python","patch_set":11,"id":"8e4a2e24_648e4ba0","line":39,"range":{"start_line":39,"start_character":5,"end_line":39,"end_character":20},"in_reply_to":"935e52e0_6cb5fafb","updated":"2022-03-11 15:40:43.000000000","message":"Done","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"}],"api-ref/source/index.rst":[{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"5829a63a069743a143b8cc99926dfbd19fb8d0ba","unresolved":true,"context_lines":[{"line_number":8,"context_line":"   :maxdepth: 2"},{"line_number":9,"context_line":"   :caption: Contents"},{"line_number":10,"context_line":""},{"line_number":11,"context_line":"   intro"},{"line_number":12,"context_line":"   modules"}],"source_content_type":"text/x-rst","patch_set":1,"id":"ed88227c_33539a9c","line":12,"range":{"start_line":11,"start_character":0,"end_line":12,"end_character":10},"updated":"2022-02-04 17:48:10.000000000","message":"So I think your missing some files in this commit?\n\nSpecifically modules","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"3e1f6e89d5524cd23d63b65cc6c0e3dbd9ac6ffa","unresolved":false,"context_lines":[{"line_number":8,"context_line":"   :maxdepth: 2"},{"line_number":9,"context_line":"   :caption: Contents"},{"line_number":10,"context_line":""},{"line_number":11,"context_line":"   intro"},{"line_number":12,"context_line":"   modules"}],"source_content_type":"text/x-rst","patch_set":1,"id":"77bda3ae_3952acdc","line":12,"range":{"start_line":11,"start_character":0,"end_line":12,"end_character":10},"in_reply_to":"ed88227c_33539a9c","updated":"2022-02-08 18:05:53.000000000","message":"The modules file is generated by apidoc (sphinx utility), and it contains all the modules present in the Ironic API directory. \nTwo commands are needed to make this work, both of which are executed from the api-ref directory: \nsphinx-apidoc -o ./source ../ironic/api/controllers/v1/\nsphinx-build -E -b html source build","commit_id":"9377b410e28053f66359cfa4966377c7aae1f14e"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"cf5757f463cd09826d5c3b8a056da2c6f1029206","unresolved":true,"context_lines":[{"line_number":34,"context_line":".. include:: baremetal-api-v1-misc.inc"},{"line_number":35,"context_line":""},{"line_number":36,"context_line":""},{"line_number":37,"context_line":".. toctree::"},{"line_number":38,"context_line":"   :maxdepth: 2"},{"line_number":39,"context_line":"   :caption: Contents"},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"   intro"}],"source_content_type":"text/x-rst","patch_set":10,"id":"35b3e910_eb8ee428","line":41,"range":{"start_line":37,"start_character":0,"end_line":41,"end_character":8},"updated":"2022-03-07 19:05:24.000000000","message":"I\u0027m a little confused by this since it doesn\u0027t actually render.\n\nhttps://storage.bhs.cloud.ovh.net/v1/AUTH_dcaab5e32b234d56b626f72581e3644c/zuul_opendev_logs_955/827200/10/check/build-openstack-api-ref/955da9e/docs/#\n\nCould you help me understand why?","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"9ad84fd659caed005b2fe3f965925f36ef00d91a","unresolved":false,"context_lines":[{"line_number":34,"context_line":".. include:: baremetal-api-v1-misc.inc"},{"line_number":35,"context_line":""},{"line_number":36,"context_line":""},{"line_number":37,"context_line":".. toctree::"},{"line_number":38,"context_line":"   :maxdepth: 2"},{"line_number":39,"context_line":"   :caption: Contents"},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"   intro"}],"source_content_type":"text/x-rst","patch_set":10,"id":"4b2155f3_e4d87e92","line":41,"range":{"start_line":37,"start_character":0,"end_line":41,"end_character":8},"in_reply_to":"0fa56af7_9e17ea91","updated":"2022-03-11 15:40:43.000000000","message":"As per our discussion, there was no need to add this toctree, as the extension can work in the doc/ directory. So I have removed this.","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"42a833cf7df974cc7c7d66ad5d290eaa0e65cd13","unresolved":true,"context_lines":[{"line_number":34,"context_line":".. include:: baremetal-api-v1-misc.inc"},{"line_number":35,"context_line":""},{"line_number":36,"context_line":""},{"line_number":37,"context_line":".. toctree::"},{"line_number":38,"context_line":"   :maxdepth: 2"},{"line_number":39,"context_line":"   :caption: Contents"},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"   intro"}],"source_content_type":"text/x-rst","patch_set":10,"id":"0fa56af7_9e17ea91","line":41,"range":{"start_line":37,"start_character":0,"end_line":41,"end_character":8},"in_reply_to":"35b3e910_eb8ee428","updated":"2022-03-08 20:25:13.000000000","message":"When I was developing this, I ran 2 commands from the api-ref directory:\nsphinx-apidoc -o ./source ../ironic/api/controllers/v1/\nThis command generated 2 files:\n - source/modules.rst: contains a reference to the v1.rst file.\n - source/v1.rst: contains a list of all the modules present in the v1 package (given as argument to the sphinx-apidoc command).\n\nI added the \u0027modules\u0027 name under the \u0027intro\u0027 mentioned here.\nThen I run the sphinx-build command from the api-ref directory:\nsphinx-build -b html -E -W source build\nThis generates the output for me in api-ref/build/html/v1.html.\n\nThe \u0027intro\u0027 page is unneccesary, I think. I have removed the reference and file.","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"055f1081c2d1b377936f1d164c8b47a96c6f93f4","unresolved":true,"context_lines":[{"line_number":32,"context_line":".. include:: baremetal-api-v1-chassis.inc"},{"line_number":33,"context_line":".. NOTE(dtantsur): keep misc last, since it covers internal API"},{"line_number":34,"context_line":".. include:: baremetal-api-v1-misc.inc"},{"line_number":35,"context_line":""},{"line_number":36,"context_line":""},{"line_number":37,"context_line":".. toctree::"},{"line_number":38,"context_line":"   :maxdepth: 2"},{"line_number":39,"context_line":"   :caption: Contents"}],"source_content_type":"text/x-rst","patch_set":11,"id":"298a9178_5dca8838","line":39,"range":{"start_line":35,"start_character":0,"end_line":39,"end_character":21},"updated":"2022-03-09 18:08:04.000000000","message":"You *might* be able to delete this then, given the other comment.","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"9ad84fd659caed005b2fe3f965925f36ef00d91a","unresolved":false,"context_lines":[{"line_number":32,"context_line":".. include:: baremetal-api-v1-chassis.inc"},{"line_number":33,"context_line":".. NOTE(dtantsur): keep misc last, since it covers internal API"},{"line_number":34,"context_line":".. include:: baremetal-api-v1-misc.inc"},{"line_number":35,"context_line":""},{"line_number":36,"context_line":""},{"line_number":37,"context_line":".. toctree::"},{"line_number":38,"context_line":"   :maxdepth: 2"},{"line_number":39,"context_line":"   :caption: Contents"}],"source_content_type":"text/x-rst","patch_set":11,"id":"9bea262e_fe482011","line":39,"range":{"start_line":35,"start_character":0,"end_line":39,"end_character":21},"in_reply_to":"298a9178_5dca8838","updated":"2022-03-11 15:40:43.000000000","message":"Done","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"}],"api-ref/source/samples/node-create-request-classic.json":[{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"055f1081c2d1b377936f1d164c8b47a96c6f93f4","unresolved":false,"context_lines":[{"line_number":1,"context_line":"{"},{"line_number":2,"context_line":"    \"name\": \"test_node_classic\","},{"line_number":3,"context_line":"    \"driver\": \"agent_ipmitool\","},{"line_number":4,"context_line":"    \"driver_info\": {"},{"line_number":5,"context_line":"        \"ipmi_username\": \"ADMIN\","},{"line_number":6,"context_line":"        \"ipmi_password\": \"password\""}],"source_content_type":"application/json","patch_set":11,"id":"056a2214_d756978c","side":"PARENT","line":3,"updated":"2022-03-09 18:08:04.000000000","message":"Thanks for deleting this.","commit_id":"365a4545fe6606b1fda8f1387e851641de25cec8"}],"doc/source/conf.py":[{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"055f1081c2d1b377936f1d164c8b47a96c6f93f4","unresolved":true,"context_lines":[{"line_number":29,"context_line":"# add these directories to sys.path here. If the directory is relative to the"},{"line_number":30,"context_line":"# documentation root, use os.path.abspath to make it absolute, like shown here."},{"line_number":31,"context_line":"sys.path.insert(0, os.path.join(os.path.abspath(\u0027.\u0027), \u0027_exts\u0027))"},{"line_number":32,"context_line":"sys.path.insert(0, os.path.abspath(\u0027../../api-ref/source/_ext/\u0027))"},{"line_number":33,"context_line":""},{"line_number":34,"context_line":"# Add any Sphinx extension module names here, as strings. They can be"},{"line_number":35,"context_line":"# extensions coming with Sphinx (named \u0027sphinx.ext.*\u0027) or your custom ones."}],"source_content_type":"text/x-python","patch_set":11,"id":"fa9fd094_2cdcfe2e","line":32,"updated":"2022-03-09 18:08:04.000000000","message":"This is here because the file, specifically WebAPIDocstring.py is located in ../../api-ref/source/_ext, and that file can be moved to ./_ext/WebAPIDocString.py, which would allow line 32 to be removed.","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"9ad84fd659caed005b2fe3f965925f36ef00d91a","unresolved":false,"context_lines":[{"line_number":29,"context_line":"# add these directories to sys.path here. If the directory is relative to the"},{"line_number":30,"context_line":"# documentation root, use os.path.abspath to make it absolute, like shown here."},{"line_number":31,"context_line":"sys.path.insert(0, os.path.join(os.path.abspath(\u0027.\u0027), \u0027_exts\u0027))"},{"line_number":32,"context_line":"sys.path.insert(0, os.path.abspath(\u0027../../api-ref/source/_ext/\u0027))"},{"line_number":33,"context_line":""},{"line_number":34,"context_line":"# Add any Sphinx extension module names here, as strings. They can be"},{"line_number":35,"context_line":"# extensions coming with Sphinx (named \u0027sphinx.ext.*\u0027) or your custom ones."}],"source_content_type":"text/x-python","patch_set":11,"id":"900eb724_4eb66889","line":32,"in_reply_to":"fa9fd094_2cdcfe2e","updated":"2022-03-11 15:40:43.000000000","message":"Done","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"}],"doc/source/contributor/api/samples/node-create-request-classic.json":[{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"cf5757f463cd09826d5c3b8a056da2c6f1029206","unresolved":true,"context_lines":[{"line_number":5,"context_line":"        \"ipmi_username\": \"ADMIN\","},{"line_number":6,"context_line":"        \"ipmi_password\": \"password\""},{"line_number":7,"context_line":"    },"},{"line_number":8,"context_line":"    \"resource_class\": \"bm-large\""},{"line_number":9,"context_line":"}"}],"source_content_type":"application/json","patch_set":10,"id":"7cdf511a_9f31f5f9","line":8,"updated":"2022-03-07 19:05:24.000000000","message":"This file is not needed, classic drivers don\u0027t exist anymore. 😊","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"42a833cf7df974cc7c7d66ad5d290eaa0e65cd13","unresolved":false,"context_lines":[{"line_number":5,"context_line":"        \"ipmi_username\": \"ADMIN\","},{"line_number":6,"context_line":"        \"ipmi_password\": \"password\""},{"line_number":7,"context_line":"    },"},{"line_number":8,"context_line":"    \"resource_class\": \"bm-large\""},{"line_number":9,"context_line":"}"}],"source_content_type":"application/json","patch_set":10,"id":"543c5374_d6dd3a98","line":8,"in_reply_to":"7cdf511a_9f31f5f9","updated":"2022-03-08 20:25:13.000000000","message":"Removed the file","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"}],"doc/source/contributor/api/samples/node-create-request-dynamic.json":[{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"cf5757f463cd09826d5c3b8a056da2c6f1029206","unresolved":true,"context_lines":[{"line_number":1,"context_line":"{"},{"line_number":2,"context_line":"    \"name\": \"test_node_dynamic\","},{"line_number":3,"context_line":"    \"driver\": \"ipmi\","},{"line_number":4,"context_line":"    \"driver_info\": {"},{"line_number":5,"context_line":"        \"ipmi_username\": \"ADMIN\","},{"line_number":6,"context_line":"        \"ipmi_password\": \"password\""},{"line_number":7,"context_line":"    },"}],"source_content_type":"application/json","patch_set":10,"id":"372fb619_c3690105","line":4,"updated":"2022-03-07 19:05:24.000000000","message":"So is the intent that someone manually edits/maintains these files? I guess that kind of makes a lot of sense.","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"42a833cf7df974cc7c7d66ad5d290eaa0e65cd13","unresolved":true,"context_lines":[{"line_number":1,"context_line":"{"},{"line_number":2,"context_line":"    \"name\": \"test_node_dynamic\","},{"line_number":3,"context_line":"    \"driver\": \"ipmi\","},{"line_number":4,"context_line":"    \"driver_info\": {"},{"line_number":5,"context_line":"        \"ipmi_username\": \"ADMIN\","},{"line_number":6,"context_line":"        \"ipmi_password\": \"password\""},{"line_number":7,"context_line":"    },"}],"source_content_type":"application/json","patch_set":10,"id":"aa2bcdfd_7baa2e58","line":4,"in_reply_to":"372fb619_c3690105","updated":"2022-03-08 20:25:13.000000000","message":"Yes, that was the idea in my mind. \nI was not sure how these files are currently generated, but I thought about keeping the same mechanism. I added them to this directory as the \u0027tox -e docs\u0027 requires them in the doc/source/contributor/api/ directory.","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"055f1081c2d1b377936f1d164c8b47a96c6f93f4","unresolved":true,"context_lines":[{"line_number":1,"context_line":"{"},{"line_number":2,"context_line":"    \"name\": \"test_node_dynamic\","},{"line_number":3,"context_line":"    \"driver\": \"ipmi\","},{"line_number":4,"context_line":"    \"driver_info\": {"},{"line_number":5,"context_line":"        \"ipmi_username\": \"ADMIN\","},{"line_number":6,"context_line":"        \"ipmi_password\": \"password\""},{"line_number":7,"context_line":"    },"}],"source_content_type":"application/json","patch_set":10,"id":"e46cc4ad_72bd3585","line":4,"in_reply_to":"aa2bcdfd_7baa2e58","updated":"2022-03-09 18:08:04.000000000","message":"Based on discussion with Mahnoor, she is going to try and re-use the existing samples from the api-ref. We believe a relative reference to the file *should* work, similar to how we point back to some of the files in the root of the git repository from the doc/source/ folder contents.\n\nThat being said, should that not work, the option of also putting a symbolic link in for samples may also be a viable option which git *should* support.","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"9ad84fd659caed005b2fe3f965925f36ef00d91a","unresolved":false,"context_lines":[{"line_number":1,"context_line":"{"},{"line_number":2,"context_line":"    \"name\": \"test_node_dynamic\","},{"line_number":3,"context_line":"    \"driver\": \"ipmi\","},{"line_number":4,"context_line":"    \"driver_info\": {"},{"line_number":5,"context_line":"        \"ipmi_username\": \"ADMIN\","},{"line_number":6,"context_line":"        \"ipmi_password\": \"password\""},{"line_number":7,"context_line":"    },"}],"source_content_type":"application/json","patch_set":10,"id":"d7a77a7d_b9a03ff7","line":4,"in_reply_to":"e46cc4ad_72bd3585","updated":"2022-03-11 15:40:43.000000000","message":"Relative referencing used now, using existing samples from api-ref :)","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"cf5757f463cd09826d5c3b8a056da2c6f1029206","unresolved":true,"context_lines":[{"line_number":3,"context_line":"    \"driver\": \"ipmi\","},{"line_number":4,"context_line":"    \"driver_info\": {"},{"line_number":5,"context_line":"        \"ipmi_username\": \"ADMIN\","},{"line_number":6,"context_line":"        \"ipmi_password\": \"password\""},{"line_number":7,"context_line":"    },"},{"line_number":8,"context_line":"    \"power_interface\": \"ipmitool\","},{"line_number":9,"context_line":"    \"resource_class\": \"bm-large\""}],"source_content_type":"application/json","patch_set":10,"id":"fdb830d5_a14b5f82","line":6,"updated":"2022-03-07 19:05:24.000000000","message":"nit: your missing ipmi_address, but for what it is worth, I think this would be better if you used redfish instead of ipmi.","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"9ad84fd659caed005b2fe3f965925f36ef00d91a","unresolved":true,"context_lines":[{"line_number":3,"context_line":"    \"driver\": \"ipmi\","},{"line_number":4,"context_line":"    \"driver_info\": {"},{"line_number":5,"context_line":"        \"ipmi_username\": \"ADMIN\","},{"line_number":6,"context_line":"        \"ipmi_password\": \"password\""},{"line_number":7,"context_line":"    },"},{"line_number":8,"context_line":"    \"power_interface\": \"ipmitool\","},{"line_number":9,"context_line":"    \"resource_class\": \"bm-large\""}],"source_content_type":"application/json","patch_set":10,"id":"33a887b2_c410f2ac","line":6,"in_reply_to":"2ee87b79_0c59b36c","updated":"2022-03-11 15:40:43.000000000","message":"Redfish is more recent, I think? I will try to switch to redfish :)","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"d8e2a673044a442d678d45ecde0a6780cdc9bc9d","unresolved":true,"context_lines":[{"line_number":3,"context_line":"    \"driver\": \"ipmi\","},{"line_number":4,"context_line":"    \"driver_info\": {"},{"line_number":5,"context_line":"        \"ipmi_username\": \"ADMIN\","},{"line_number":6,"context_line":"        \"ipmi_password\": \"password\""},{"line_number":7,"context_line":"    },"},{"line_number":8,"context_line":"    \"power_interface\": \"ipmitool\","},{"line_number":9,"context_line":"    \"resource_class\": \"bm-large\""}],"source_content_type":"application/json","patch_set":10,"id":"cd70fbfa_125ecac2","line":6,"in_reply_to":"33a887b2_c410f2ac","updated":"2022-03-11 16:22:08.000000000","message":"Since I am now referencing the existing sample files (from the api-ref directory), would it be necessary to change this?","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"055f1081c2d1b377936f1d164c8b47a96c6f93f4","unresolved":true,"context_lines":[{"line_number":3,"context_line":"    \"driver\": \"ipmi\","},{"line_number":4,"context_line":"    \"driver_info\": {"},{"line_number":5,"context_line":"        \"ipmi_username\": \"ADMIN\","},{"line_number":6,"context_line":"        \"ipmi_password\": \"password\""},{"line_number":7,"context_line":"    },"},{"line_number":8,"context_line":"    \"power_interface\": \"ipmitool\","},{"line_number":9,"context_line":"    \"resource_class\": \"bm-large\""}],"source_content_type":"application/json","patch_set":10,"id":"2ee87b79_0c59b36c","line":6,"in_reply_to":"fdb830d5_a14b5f82","updated":"2022-03-09 18:08:04.000000000","message":"I found this is actually a copy of the api-ref which explicitly removes the field for unknown reasons. :\\","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"}],"ironic/api/controllers/v1/allocation.py":[{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"cf5757f463cd09826d5c3b8a056da2c6f1029206","unresolved":true,"context_lines":[{"line_number":515,"context_line":""},{"line_number":516,"context_line":"        .. parameters:: parameters.yaml"},{"line_number":517,"context_line":""},{"line_number":518,"context_line":"           :allocation_ident: allocation_ident"},{"line_number":519,"context_line":"        \"\"\""},{"line_number":520,"context_line":"        context \u003d api.request.context"},{"line_number":521,"context_line":"        rpc_allocation \u003d api_utils.check_allocation_policy_and_retrieve("}],"source_content_type":"text/x-python","patch_set":10,"id":"ef811019_1b4ba814","line":518,"updated":"2022-03-07 19:05:24.000000000","message":"Definitely results in cleaner display/delineation to me.\n\nhttps://storage.bhs.cloud.ovh.net/v1/AUTH_dcaab5e32b234d56b626f72581e3644c/zuul_opendev_logs_11f/827200/10/check/openstack-tox-docs/11f2188/docs/contributor/api/ironic.api.controllers.v1.allocation.html","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":15519,"name":"Iury Gregory Melo Ferreira","display_name":"Iury Gregory","email":"iurygregory@gmail.com","username":"iurygregory"},"change_message_id":"52eda5a25ac8c31ce1899be6b175f6d2254193c7","unresolved":true,"context_lines":[{"line_number":515,"context_line":""},{"line_number":516,"context_line":"        .. parameters:: parameters.yaml"},{"line_number":517,"context_line":""},{"line_number":518,"context_line":"           :allocation_ident: allocation_ident"},{"line_number":519,"context_line":"        \"\"\""},{"line_number":520,"context_line":"        context \u003d api.request.context"},{"line_number":521,"context_line":"        rpc_allocation \u003d api_utils.check_allocation_policy_and_retrieve("}],"source_content_type":"text/x-python","patch_set":10,"id":"925854a2_cf58b5cd","line":518,"in_reply_to":"841b3f9a_794cdec9","updated":"2022-03-17 13:45:49.000000000","message":"I really liked this!","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"42a833cf7df974cc7c7d66ad5d290eaa0e65cd13","unresolved":true,"context_lines":[{"line_number":515,"context_line":""},{"line_number":516,"context_line":"        .. parameters:: parameters.yaml"},{"line_number":517,"context_line":""},{"line_number":518,"context_line":"           :allocation_ident: allocation_ident"},{"line_number":519,"context_line":"        \"\"\""},{"line_number":520,"context_line":"        context \u003d api.request.context"},{"line_number":521,"context_line":"        rpc_allocation \u003d api_utils.check_allocation_policy_and_retrieve("}],"source_content_type":"text/x-python","patch_set":10,"id":"841b3f9a_794cdec9","line":518,"in_reply_to":"ef811019_1b4ba814","updated":"2022-03-08 20:25:13.000000000","message":"Acknowledged","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":4571,"name":"Steve Baker","email":"sbaker@redhat.com","username":"steve-stevebaker"},"change_message_id":"a7b72fb0d9e199110c6bfd07e286ba3622f09150","unresolved":true,"context_lines":[{"line_number":509,"context_line":""},{"line_number":510,"context_line":"    @METRICS.timer(\u0027AllocationsController.delete\u0027)"},{"line_number":511,"context_line":"    @method.expose(status_code\u003dhttp_client.NO_CONTENT)"},{"line_number":512,"context_line":"    @args.validate(allocation_ident\u003dargs.uuid_or_name)"},{"line_number":513,"context_line":"    def delete(self, allocation_ident):"},{"line_number":514,"context_line":"        \"\"\"Delete an allocation."},{"line_number":515,"context_line":""}],"source_content_type":"text/x-python","patch_set":11,"id":"0bbed513_5055b915","line":512,"updated":"2022-03-10 01:40:17.000000000","message":"I don\u0027t want to derail this exploration of docstrings, but it would be nice if these decorators could be inspected to be one of the sources for building the api ref. I\u0027ll have a look into modules like \u0027inspect\u0027, \u0027inspect.signature\u0027, and \u0027ast\u0027 to see if there is a practical way of doing that.","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"},{"author":{"_account_id":4571,"name":"Steve Baker","email":"sbaker@redhat.com","username":"steve-stevebaker"},"change_message_id":"d74220448cbe2db2713940efccdbd4480462abf8","unresolved":true,"context_lines":[{"line_number":509,"context_line":""},{"line_number":510,"context_line":"    @METRICS.timer(\u0027AllocationsController.delete\u0027)"},{"line_number":511,"context_line":"    @method.expose(status_code\u003dhttp_client.NO_CONTENT)"},{"line_number":512,"context_line":"    @args.validate(allocation_ident\u003dargs.uuid_or_name)"},{"line_number":513,"context_line":"    def delete(self, allocation_ident):"},{"line_number":514,"context_line":"        \"\"\"Delete an allocation."},{"line_number":515,"context_line":""}],"source_content_type":"text/x-python","patch_set":11,"id":"1467a0c2_93f86761","line":512,"in_reply_to":"0bbed513_5055b915","updated":"2022-03-10 02:04:56.000000000","message":"This will give you the whole syntax tree for a class, I\u0027ll come up with something a little more refined tomorrow:\n\nimport inspect\nimport ast\n\nfrom ironic.api.controllers.v1 import allocation\n\ns \u003d inspect.getsource(allocation.AllocationsController)\ntree \u003d ast.parse(s)\nprint(ast.dump(tree, indent\u003d2))","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"4a6138d8079aa4889fac783d46789ea9f4620ceb","unresolved":true,"context_lines":[{"line_number":509,"context_line":""},{"line_number":510,"context_line":"    @METRICS.timer(\u0027AllocationsController.delete\u0027)"},{"line_number":511,"context_line":"    @method.expose(status_code\u003dhttp_client.NO_CONTENT)"},{"line_number":512,"context_line":"    @args.validate(allocation_ident\u003dargs.uuid_or_name)"},{"line_number":513,"context_line":"    def delete(self, allocation_ident):"},{"line_number":514,"context_line":"        \"\"\"Delete an allocation."},{"line_number":515,"context_line":""}],"source_content_type":"text/x-python","patch_set":11,"id":"01afe146_d3c09114","line":512,"in_reply_to":"1467a0c2_93f86761","updated":"2022-03-11 16:42:18.000000000","message":"This looks very interesting. \nI think the it would be possible to get structural information (method name, parameters names) using a module like inspect, perhaps. And maybe its documentation could be accessed via the __doc__ attribute.\nCurrently, the Ironic documentation is being generated using Sphinx, so I thought a plug in into the current framework would help retain the same process, while easing API documentation.","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"958e2d90db2288715221bb5a673c6a393d217c7f","unresolved":true,"context_lines":[{"line_number":269,"context_line":"           :sort_key: sort_key"},{"line_number":270,"context_line":"           :sort_dir: sort_dir"},{"line_number":271,"context_line":"           :fields: fields"},{"line_number":272,"context_line":"           :owner: r_owner"},{"line_number":273,"context_line":"        \"\"\""},{"line_number":274,"context_line":"        owner \u003d api_utils.check_list_policy(\u0027allocation\u0027, owner)"},{"line_number":275,"context_line":""}],"source_content_type":"text/x-python","patch_set":12,"id":"47fa59a0_48f60ecc","line":272,"updated":"2022-03-15 16:32:56.000000000","message":"Truthfully, this results in some impressive output. Great job!","commit_id":"fd9f0a93748457a38d8124a4dee0159de0c51c68"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"a3d79f747b3be4314638351d89a9dc56ee8b4e55","unresolved":false,"context_lines":[{"line_number":269,"context_line":"           :sort_key: sort_key"},{"line_number":270,"context_line":"           :sort_dir: sort_dir"},{"line_number":271,"context_line":"           :fields: fields"},{"line_number":272,"context_line":"           :owner: r_owner"},{"line_number":273,"context_line":"        \"\"\""},{"line_number":274,"context_line":"        owner \u003d api_utils.check_list_policy(\u0027allocation\u0027, owner)"},{"line_number":275,"context_line":""}],"source_content_type":"text/x-python","patch_set":12,"id":"1f16e38c_3fbe4b2f","line":272,"in_reply_to":"47fa59a0_48f60ecc","updated":"2022-03-16 20:24:39.000000000","message":"Thank you!","commit_id":"fd9f0a93748457a38d8124a4dee0159de0c51c68"}],"ironic/api/controllers/v1/driver.py":[{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"24013cba8e4afc2b42145bad4555fe1cb3559c61","unresolved":true,"context_lines":[{"line_number":225,"context_line":"        :param driver_name: name of the driver."},{"line_number":226,"context_line":"        :returns: dictionary with \u003cvendor method name\u003e:\u003cmethod metadata\u003e"},{"line_number":227,"context_line":"                  entries."},{"line_number":228,"context_line":"        :raises DriverNotFound: if the driver name is invalid or the"},{"line_number":229,"context_line":"                 driver cannot be loaded."},{"line_number":230,"context_line":"        \"\"\""},{"line_number":231,"context_line":"        api_utils.check_policy(\u0027baremetal:driver:vendor_passthru\u0027)"},{"line_number":232,"context_line":""}],"source_content_type":"text/x-python","patch_set":5,"id":"77dd1c04_2ead3459","line":229,"range":{"start_line":228,"start_character":0,"end_line":229,"end_character":41},"updated":"2022-02-23 17:06:19.000000000","message":"Thanks!","commit_id":"d77ffa5fd90ced2efe4464836e48ce5cdcfff788"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"1bfbd041e6a72be9bb0e7d1f94c563bb97780e45","unresolved":false,"context_lines":[{"line_number":225,"context_line":"        :param driver_name: name of the driver."},{"line_number":226,"context_line":"        :returns: dictionary with \u003cvendor method name\u003e:\u003cmethod metadata\u003e"},{"line_number":227,"context_line":"                  entries."},{"line_number":228,"context_line":"        :raises DriverNotFound: if the driver name is invalid or the"},{"line_number":229,"context_line":"                 driver cannot be loaded."},{"line_number":230,"context_line":"        \"\"\""},{"line_number":231,"context_line":"        api_utils.check_policy(\u0027baremetal:driver:vendor_passthru\u0027)"},{"line_number":232,"context_line":""}],"source_content_type":"text/x-python","patch_set":5,"id":"6f4b6ff1_ed719180","line":229,"range":{"start_line":228,"start_character":0,"end_line":229,"end_character":41},"in_reply_to":"77dd1c04_2ead3459","updated":"2022-02-25 16:49:32.000000000","message":":)","commit_id":"d77ffa5fd90ced2efe4464836e48ce5cdcfff788"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"24013cba8e4afc2b42145bad4555fe1cb3559c61","unresolved":true,"context_lines":[{"line_number":265,"context_line":"    _custom_actions \u003d {"},{"line_number":266,"context_line":"        \u0027logical_disk_properties\u0027: [\u0027GET\u0027]"},{"line_number":267,"context_line":"    }"},{"line_number":268,"context_line":"    \"\"\""},{"line_number":269,"context_line":"    :returns: A dictionary containing the properties that can be mentioned"},{"line_number":270,"context_line":"        for logical disks and a textual description for them."},{"line_number":271,"context_line":"    :raises UnsupportedDriverExtension: if the driver doesn\u0027t"},{"line_number":272,"context_line":"        support RAID configuration."},{"line_number":273,"context_line":"    :raises NotAcceptable: if requested version of the API is less than"},{"line_number":274,"context_line":"        1.12."},{"line_number":275,"context_line":"    :raises DriverNotFound: if driver is not loaded on any of the"},{"line_number":276,"context_line":"        conductors."},{"line_number":277,"context_line":"    \"\"\""},{"line_number":278,"context_line":"    @METRICS.timer(\u0027DriverRaidController.logical_disk_properties\u0027)"},{"line_number":279,"context_line":"    @method.expose()"},{"line_number":280,"context_line":"    @args.validate(driver_name\u003dargs.string)"}],"source_content_type":"text/x-python","patch_set":5,"id":"eceff8de_1537f357","line":277,"range":{"start_line":268,"start_character":0,"end_line":277,"end_character":7},"updated":"2022-02-23 17:06:19.000000000","message":"I\u0027m a little confused by this?","commit_id":"d77ffa5fd90ced2efe4464836e48ce5cdcfff788"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"1bfbd041e6a72be9bb0e7d1f94c563bb97780e45","unresolved":false,"context_lines":[{"line_number":265,"context_line":"    _custom_actions \u003d {"},{"line_number":266,"context_line":"        \u0027logical_disk_properties\u0027: [\u0027GET\u0027]"},{"line_number":267,"context_line":"    }"},{"line_number":268,"context_line":"    \"\"\""},{"line_number":269,"context_line":"    :returns: A dictionary containing the properties that can be mentioned"},{"line_number":270,"context_line":"        for logical disks and a textual description for them."},{"line_number":271,"context_line":"    :raises UnsupportedDriverExtension: if the driver doesn\u0027t"},{"line_number":272,"context_line":"        support RAID configuration."},{"line_number":273,"context_line":"    :raises NotAcceptable: if requested version of the API is less than"},{"line_number":274,"context_line":"        1.12."},{"line_number":275,"context_line":"    :raises DriverNotFound: if driver is not loaded on any of the"},{"line_number":276,"context_line":"        conductors."},{"line_number":277,"context_line":"    \"\"\""},{"line_number":278,"context_line":"    @METRICS.timer(\u0027DriverRaidController.logical_disk_properties\u0027)"},{"line_number":279,"context_line":"    @method.expose()"},{"line_number":280,"context_line":"    @args.validate(driver_name\u003dargs.string)"}],"source_content_type":"text/x-python","patch_set":5,"id":"3b026444_8bf424be","line":277,"range":{"start_line":268,"start_character":0,"end_line":277,"end_character":7},"in_reply_to":"eceff8de_1537f357","updated":"2022-02-25 16:49:32.000000000","message":"This was added by mistake. Removed now.","commit_id":"d77ffa5fd90ced2efe4464836e48ce5cdcfff788"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"24013cba8e4afc2b42145bad4555fe1cb3559c61","unresolved":true,"context_lines":[{"line_number":390,"context_line":"        :param driver_name: name of the driver."},{"line_number":391,"context_line":"        :returns: dictionary with \u003cproperty name\u003e:\u003cproperty description\u003e"},{"line_number":392,"context_line":"                  entries."},{"line_number":393,"context_line":"        :raises DriverNotFound (HTTP 404): if the driver name is invalid or"},{"line_number":394,"context_line":"                 the driver cannot be loaded."},{"line_number":395,"context_line":"        \"\"\""},{"line_number":396,"context_line":"        api_utils.check_policy(\u0027baremetal:driver:get_properties\u0027)"},{"line_number":397,"context_line":""}],"source_content_type":"text/x-python","patch_set":5,"id":"46b866a3_a85e0614","line":394,"range":{"start_line":393,"start_character":0,"end_line":394,"end_character":45},"updated":"2022-02-23 17:06:19.000000000","message":"Thanks!","commit_id":"d77ffa5fd90ced2efe4464836e48ce5cdcfff788"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"1bfbd041e6a72be9bb0e7d1f94c563bb97780e45","unresolved":false,"context_lines":[{"line_number":390,"context_line":"        :param driver_name: name of the driver."},{"line_number":391,"context_line":"        :returns: dictionary with \u003cproperty name\u003e:\u003cproperty description\u003e"},{"line_number":392,"context_line":"                  entries."},{"line_number":393,"context_line":"        :raises DriverNotFound (HTTP 404): if the driver name is invalid or"},{"line_number":394,"context_line":"                 the driver cannot be loaded."},{"line_number":395,"context_line":"        \"\"\""},{"line_number":396,"context_line":"        api_utils.check_policy(\u0027baremetal:driver:get_properties\u0027)"},{"line_number":397,"context_line":""}],"source_content_type":"text/x-python","patch_set":5,"id":"a685659c_4341fd99","line":394,"range":{"start_line":393,"start_character":0,"end_line":394,"end_character":45},"in_reply_to":"46b866a3_a85e0614","updated":"2022-02-25 16:49:32.000000000","message":":)","commit_id":"d77ffa5fd90ced2efe4464836e48ce5cdcfff788"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"cf5757f463cd09826d5c3b8a056da2c6f1029206","unresolved":true,"context_lines":[{"line_number":272,"context_line":"    def logical_disk_properties(self, driver_name):"},{"line_number":273,"context_line":"        \"\"\"Returns the logical disk properties for the driver."},{"line_number":274,"context_line":""},{"line_number":275,"context_line":"        .. parameters:: parameters.yaml"},{"line_number":276,"context_line":""},{"line_number":277,"context_line":"           :driver_name: Name of the driver."},{"line_number":278,"context_line":""}],"source_content_type":"text/x-python","patch_set":10,"id":"6bbe69d4_8df3a330","line":275,"updated":"2022-03-07 19:05:24.000000000","message":"for reviewers, this is what this file\u0027s change results in: https://storage.bhs.cloud.ovh.net/v1/AUTH_dcaab5e32b234d56b626f72581e3644c/zuul_opendev_logs_11f/827200/10/check/openstack-tox-docs/11f2188/docs/contributor/api/ironic.api.controllers.v1.driver.html#ironic.api.controllers.v1.driver.DriverRaidController","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":15519,"name":"Iury Gregory Melo Ferreira","display_name":"Iury Gregory","email":"iurygregory@gmail.com","username":"iurygregory"},"change_message_id":"52eda5a25ac8c31ce1899be6b175f6d2254193c7","unresolved":true,"context_lines":[{"line_number":272,"context_line":"    def logical_disk_properties(self, driver_name):"},{"line_number":273,"context_line":"        \"\"\"Returns the logical disk properties for the driver."},{"line_number":274,"context_line":""},{"line_number":275,"context_line":"        .. parameters:: parameters.yaml"},{"line_number":276,"context_line":""},{"line_number":277,"context_line":"           :driver_name: Name of the driver."},{"line_number":278,"context_line":""}],"source_content_type":"text/x-python","patch_set":10,"id":"a10e0848_24f2f092","line":275,"in_reply_to":"63fe3b09_0b1d99b6","updated":"2022-03-17 13:45:49.000000000","message":"Nice Job \u003d)","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"42a833cf7df974cc7c7d66ad5d290eaa0e65cd13","unresolved":true,"context_lines":[{"line_number":272,"context_line":"    def logical_disk_properties(self, driver_name):"},{"line_number":273,"context_line":"        \"\"\"Returns the logical disk properties for the driver."},{"line_number":274,"context_line":""},{"line_number":275,"context_line":"        .. parameters:: parameters.yaml"},{"line_number":276,"context_line":""},{"line_number":277,"context_line":"           :driver_name: Name of the driver."},{"line_number":278,"context_line":""}],"source_content_type":"text/x-python","patch_set":10,"id":"63fe3b09_0b1d99b6","line":275,"in_reply_to":"6bbe69d4_8df3a330","updated":"2022-03-08 20:25:13.000000000","message":"Acknowledged","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"d4a3949cc7120891af60c894d7769999471bf6d6","unresolved":true,"context_lines":[{"line_number":272,"context_line":"    def logical_disk_properties(self, driver_name):"},{"line_number":273,"context_line":"        \"\"\"Returns the logical disk properties for the driver."},{"line_number":274,"context_line":""},{"line_number":275,"context_line":"        .. parameters:: parameters.yaml"},{"line_number":276,"context_line":""},{"line_number":277,"context_line":"           :driver_name: Name of the driver."},{"line_number":278,"context_line":""}],"source_content_type":"text/x-python","patch_set":10,"id":"25b3ec66_b42f0361","line":275,"in_reply_to":"a10e0848_24f2f092","updated":"2022-03-17 20:17:00.000000000","message":"Thank you!","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"cf5757f463cd09826d5c3b8a056da2c6f1029206","unresolved":true,"context_lines":[{"line_number":286,"context_line":"                                        configuration."},{"line_number":287,"context_line":"           :NotAcceptable: If requested version of the API is less than 1.12."},{"line_number":288,"context_line":"           :DriverNotFound: If driver is not loaded on any of the conductors."},{"line_number":289,"context_line":"           :NodeTagNotFound: If there is no node tag."},{"line_number":290,"context_line":"        \"\"\""},{"line_number":291,"context_line":"        api_utils.check_policy("},{"line_number":292,"context_line":"            \u0027baremetal:driver:get_raid_logical_disk_properties\u0027)"}],"source_content_type":"text/x-python","patch_set":10,"id":"84251e64_aac8ad68","line":289,"range":{"start_line":289,"start_character":0,"end_line":289,"end_character":53},"updated":"2022-03-07 19:05:24.000000000","message":"Unrelated? This wasn\u0027t there previously.","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"42a833cf7df974cc7c7d66ad5d290eaa0e65cd13","unresolved":false,"context_lines":[{"line_number":286,"context_line":"                                        configuration."},{"line_number":287,"context_line":"           :NotAcceptable: If requested version of the API is less than 1.12."},{"line_number":288,"context_line":"           :DriverNotFound: If driver is not loaded on any of the conductors."},{"line_number":289,"context_line":"           :NodeTagNotFound: If there is no node tag."},{"line_number":290,"context_line":"        \"\"\""},{"line_number":291,"context_line":"        api_utils.check_policy("},{"line_number":292,"context_line":"            \u0027baremetal:driver:get_raid_logical_disk_properties\u0027)"}],"source_content_type":"text/x-python","patch_set":10,"id":"95eba41d_a6648fc5","line":289,"range":{"start_line":289,"start_character":0,"end_line":289,"end_character":53},"in_reply_to":"84251e64_aac8ad68","updated":"2022-03-08 20:25:13.000000000","message":"I added this for programming purposes, and forgot to remove it. Removed now","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"cf5757f463cd09826d5c3b8a056da2c6f1029206","unresolved":true,"context_lines":[{"line_number":383,"context_line":"        :param driver_name: name of the driver."},{"line_number":384,"context_line":"        :returns: dictionary with \u003cproperty name\u003e:\u003cproperty description\u003e"},{"line_number":385,"context_line":"                  entries."},{"line_number":386,"context_line":"        :raises DriverNotFound (HTTP 404): if the driver name is invalid or"},{"line_number":387,"context_line":"                 the driver cannot be loaded."},{"line_number":388,"context_line":"        \"\"\""},{"line_number":389,"context_line":"        api_utils.check_policy(\u0027baremetal:driver:get_properties\u0027)"}],"source_content_type":"text/x-python","patch_set":10,"id":"8445d43b_50a5bc30","line":386,"range":{"start_line":386,"start_character":12,"end_line":386,"end_character":34},"updated":"2022-03-07 19:05:24.000000000","message":"So this kind of highlights the one thing we\u0027re loosing right now, and I think it would be reasonable to potentially try and maintain it. This renders with a link: https://storage.bhs.cloud.ovh.net/v1/AUTH_dcaab5e32b234d56b626f72581e3644c/zuul_opendev_logs_11f/827200/10/check/openstack-tox-docs/11f2188/docs/contributor/api/ironic.common.exception.html#ironic.common.exception.DriverNotFound\n\nNot that the link is *super* useful immediately, but it does provide a continued path. Maybe it is just more confusion than it helps. I\u0027d love other\u0027s opinions on if it makes sense to try and maintain the links.","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"8a4da780234823c2ff107f27b078ef68ae73aea1","unresolved":true,"context_lines":[{"line_number":383,"context_line":"        :param driver_name: name of the driver."},{"line_number":384,"context_line":"        :returns: dictionary with \u003cproperty name\u003e:\u003cproperty description\u003e"},{"line_number":385,"context_line":"                  entries."},{"line_number":386,"context_line":"        :raises DriverNotFound (HTTP 404): if the driver name is invalid or"},{"line_number":387,"context_line":"                 the driver cannot be loaded."},{"line_number":388,"context_line":"        \"\"\""},{"line_number":389,"context_line":"        api_utils.check_policy(\u0027baremetal:driver:get_properties\u0027)"}],"source_content_type":"text/x-python","patch_set":10,"id":"1f839c05_6b186186","line":386,"range":{"start_line":386,"start_character":12,"end_line":386,"end_character":34},"in_reply_to":"6e21ae54_3acfb848","updated":"2022-03-11 17:24:03.000000000","message":"I changed this from `:raises: exc` to `:raises exc:` because in the old way, when multiple such directives are written together, they all get a separate \u0027Raises\u0027 heading. For example, see this method: [1]\nAlso, the changed way was the recommended way to use the directive. [2]\n\nThe HTTP code can easily be moved to the description, if that is desired.\nIt can also be moved back to the way it was, if the link is not desired in the output. \n\n[1]: https://storage.bhs.cloud.ovh.net/v1/AUTH_dcaab5e32b234d56b626f72581e3644c/zuul_opendev_logs_11f/827200/10/check/openstack-tox-docs/11f2188/docs/contributor/api/ironic.api.controllers.v1.node.html#:~:text\u003dclass%20ironic.api.controllers.v1.node.InjectNmiController(*args%2C%20**kwargs)%5Bsource%5D%C2%B6\n\n[2]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#:~:text\u003d%3Araises%20ValueError%3A%20if%20the%20message_body%20exceeds%20160%20characters","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"42a833cf7df974cc7c7d66ad5d290eaa0e65cd13","unresolved":true,"context_lines":[{"line_number":383,"context_line":"        :param driver_name: name of the driver."},{"line_number":384,"context_line":"        :returns: dictionary with \u003cproperty name\u003e:\u003cproperty description\u003e"},{"line_number":385,"context_line":"                  entries."},{"line_number":386,"context_line":"        :raises DriverNotFound (HTTP 404): if the driver name is invalid or"},{"line_number":387,"context_line":"                 the driver cannot be loaded."},{"line_number":388,"context_line":"        \"\"\""},{"line_number":389,"context_line":"        api_utils.check_policy(\u0027baremetal:driver:get_properties\u0027)"}],"source_content_type":"text/x-python","patch_set":10,"id":"b4c03da6_4674d403","line":386,"range":{"start_line":386,"start_character":12,"end_line":386,"end_character":34},"in_reply_to":"8445d43b_50a5bc30","updated":"2022-03-08 20:25:13.000000000","message":"I did not realize this added a link! I agree that it might be very useful. Suggestions are welcome from others, about the maintenance implications","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"055f1081c2d1b377936f1d164c8b47a96c6f93f4","unresolved":true,"context_lines":[{"line_number":383,"context_line":"        :param driver_name: name of the driver."},{"line_number":384,"context_line":"        :returns: dictionary with \u003cproperty name\u003e:\u003cproperty description\u003e"},{"line_number":385,"context_line":"                  entries."},{"line_number":386,"context_line":"        :raises DriverNotFound (HTTP 404): if the driver name is invalid or"},{"line_number":387,"context_line":"                 the driver cannot be loaded."},{"line_number":388,"context_line":"        \"\"\""},{"line_number":389,"context_line":"        api_utils.check_policy(\u0027baremetal:driver:get_properties\u0027)"}],"source_content_type":"text/x-python","patch_set":10,"id":"e0b6e517_07c78416","line":386,"range":{"start_line":386,"start_character":12,"end_line":386,"end_character":34},"in_reply_to":"b4c03da6_4674d403","updated":"2022-03-09 18:08:04.000000000","message":"Note reflecting discussion with Mahnoor: I feel like it might not matter that links are no longer present, given that this chagne basically provides the same level of detail with less navigation of someone exploring the documentation. They *can* still find it if they want, but the linked item is also not detailed.","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":4571,"name":"Steve Baker","email":"sbaker@redhat.com","username":"steve-stevebaker"},"change_message_id":"a7b72fb0d9e199110c6bfd07e286ba3622f09150","unresolved":true,"context_lines":[{"line_number":383,"context_line":"        :param driver_name: name of the driver."},{"line_number":384,"context_line":"        :returns: dictionary with \u003cproperty name\u003e:\u003cproperty description\u003e"},{"line_number":385,"context_line":"                  entries."},{"line_number":386,"context_line":"        :raises DriverNotFound (HTTP 404): if the driver name is invalid or"},{"line_number":387,"context_line":"                 the driver cannot be loaded."},{"line_number":388,"context_line":"        \"\"\""},{"line_number":389,"context_line":"        api_utils.check_policy(\u0027baremetal:driver:get_properties\u0027)"}],"source_content_type":"text/x-python","patch_set":10,"id":"6e21ae54_3acfb848","line":386,"range":{"start_line":386,"start_character":12,"end_line":386,"end_character":34},"in_reply_to":"e0b6e517_07c78416","updated":"2022-03-10 01:40:17.000000000","message":"Maybe the (HTTP 404) can be moved to the description? The link is preserved and it gives the extra context without an extra click?","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"}],"ironic/api/controllers/v1/node.py":[{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"cf5757f463cd09826d5c3b8a056da2c6f1029206","unresolved":true,"context_lines":[{"line_number":2455,"context_line":""},{"line_number":2456,"context_line":"        .. literalinclude:: samples/node-create-request-dynamic.json"},{"line_number":2457,"context_line":"           :language: javascript"},{"line_number":2458,"context_line":""},{"line_number":2459,"context_line":"        **Example Node creation request with a classic driver:**"},{"line_number":2460,"context_line":""},{"line_number":2461,"context_line":"        .. literalinclude:: samples/node-create-request-classic.json"}],"source_content_type":"text/x-python","patch_set":10,"id":"7f7d8a3c_2b8b110b","line":2458,"updated":"2022-03-07 19:05:24.000000000","message":"I really like the practical example standpoint for some of these operations, for what it is worth.\n\nhttps://storage.bhs.cloud.ovh.net/v1/AUTH_dcaab5e32b234d56b626f72581e3644c/zuul_opendev_logs_11f/827200/10/check/openstack-tox-docs/11f2188/docs/contributor/api/ironic.api.controllers.v1.node.html#ironic.api.controllers.v1.node.NodesController.post","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"d4a3949cc7120891af60c894d7769999471bf6d6","unresolved":true,"context_lines":[{"line_number":2455,"context_line":""},{"line_number":2456,"context_line":"        .. literalinclude:: samples/node-create-request-dynamic.json"},{"line_number":2457,"context_line":"           :language: javascript"},{"line_number":2458,"context_line":""},{"line_number":2459,"context_line":"        **Example Node creation request with a classic driver:**"},{"line_number":2460,"context_line":""},{"line_number":2461,"context_line":"        .. literalinclude:: samples/node-create-request-classic.json"}],"source_content_type":"text/x-python","patch_set":10,"id":"89a60047_286a5ca9","line":2458,"in_reply_to":"015e30f7_e37051f2","updated":"2022-03-17 20:17:00.000000000","message":"Thank you! I hope so too","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"42a833cf7df974cc7c7d66ad5d290eaa0e65cd13","unresolved":true,"context_lines":[{"line_number":2455,"context_line":""},{"line_number":2456,"context_line":"        .. literalinclude:: samples/node-create-request-dynamic.json"},{"line_number":2457,"context_line":"           :language: javascript"},{"line_number":2458,"context_line":""},{"line_number":2459,"context_line":"        **Example Node creation request with a classic driver:**"},{"line_number":2460,"context_line":""},{"line_number":2461,"context_line":"        .. literalinclude:: samples/node-create-request-classic.json"}],"source_content_type":"text/x-python","patch_set":10,"id":"8ab35f76_6bbd5065","line":2458,"in_reply_to":"7f7d8a3c_2b8b110b","updated":"2022-03-08 20:25:13.000000000","message":"It definitely adds value","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":15519,"name":"Iury Gregory Melo Ferreira","display_name":"Iury Gregory","email":"iurygregory@gmail.com","username":"iurygregory"},"change_message_id":"52eda5a25ac8c31ce1899be6b175f6d2254193c7","unresolved":true,"context_lines":[{"line_number":2455,"context_line":""},{"line_number":2456,"context_line":"        .. literalinclude:: samples/node-create-request-dynamic.json"},{"line_number":2457,"context_line":"           :language: javascript"},{"line_number":2458,"context_line":""},{"line_number":2459,"context_line":"        **Example Node creation request with a classic driver:**"},{"line_number":2460,"context_line":""},{"line_number":2461,"context_line":"        .. literalinclude:: samples/node-create-request-classic.json"}],"source_content_type":"text/x-python","patch_set":10,"id":"015e30f7_e37051f2","line":2458,"in_reply_to":"8ab35f76_6bbd5065","updated":"2022-03-17 13:45:49.000000000","message":"Great job, if we check the old docs we can see a great difference. It will definitely help operators/users \u003d)","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"cf5757f463cd09826d5c3b8a056da2c6f1029206","unresolved":true,"context_lines":[{"line_number":2456,"context_line":"        .. literalinclude:: samples/node-create-request-dynamic.json"},{"line_number":2457,"context_line":"           :language: javascript"},{"line_number":2458,"context_line":""},{"line_number":2459,"context_line":"        **Example Node creation request with a classic driver:**"},{"line_number":2460,"context_line":""},{"line_number":2461,"context_line":"        .. literalinclude:: samples/node-create-request-classic.json"},{"line_number":2462,"context_line":"           :language: javascript"},{"line_number":2463,"context_line":"        \"\"\""},{"line_number":2464,"context_line":"        if self.from_chassis:"},{"line_number":2465,"context_line":"            raise exception.OperationNotPermitted()"}],"source_content_type":"text/x-python","patch_set":10,"id":"b7dd8f88_a85732a1","line":2462,"range":{"start_line":2459,"start_character":64,"end_line":2462,"end_character":32},"updated":"2022-03-07 19:05:24.000000000","message":"You can remove the classic driver reference, they are not a thing anymore.","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"055f1081c2d1b377936f1d164c8b47a96c6f93f4","unresolved":false,"context_lines":[{"line_number":2456,"context_line":"        .. literalinclude:: samples/node-create-request-dynamic.json"},{"line_number":2457,"context_line":"           :language: javascript"},{"line_number":2458,"context_line":""},{"line_number":2459,"context_line":"        **Example Node creation request with a classic driver:**"},{"line_number":2460,"context_line":""},{"line_number":2461,"context_line":"        .. literalinclude:: samples/node-create-request-classic.json"},{"line_number":2462,"context_line":"           :language: javascript"},{"line_number":2463,"context_line":"        \"\"\""},{"line_number":2464,"context_line":"        if self.from_chassis:"},{"line_number":2465,"context_line":"            raise exception.OperationNotPermitted()"}],"source_content_type":"text/x-python","patch_set":10,"id":"9ec9e42b_53a04059","line":2462,"range":{"start_line":2459,"start_character":64,"end_line":2462,"end_character":32},"in_reply_to":"4f7f6a5d_5dde9ab6","updated":"2022-03-09 18:08:04.000000000","message":"Okay, understanding these files were copied, the classic entries just no longer make sense.","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"42a833cf7df974cc7c7d66ad5d290eaa0e65cd13","unresolved":true,"context_lines":[{"line_number":2456,"context_line":"        .. literalinclude:: samples/node-create-request-dynamic.json"},{"line_number":2457,"context_line":"           :language: javascript"},{"line_number":2458,"context_line":""},{"line_number":2459,"context_line":"        **Example Node creation request with a classic driver:**"},{"line_number":2460,"context_line":""},{"line_number":2461,"context_line":"        .. literalinclude:: samples/node-create-request-classic.json"},{"line_number":2462,"context_line":"           :language: javascript"},{"line_number":2463,"context_line":"        \"\"\""},{"line_number":2464,"context_line":"        if self.from_chassis:"},{"line_number":2465,"context_line":"            raise exception.OperationNotPermitted()"}],"source_content_type":"text/x-python","patch_set":10,"id":"4f7f6a5d_5dde9ab6","line":2462,"range":{"start_line":2459,"start_character":64,"end_line":2462,"end_character":32},"in_reply_to":"b7dd8f88_a85732a1","updated":"2022-03-08 20:25:13.000000000","message":"Removed, thank you for pointing it out!","commit_id":"cfea810f84ce645d51a0c3f8080c01eb19f665c5"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"055f1081c2d1b377936f1d164c8b47a96c6f93f4","unresolved":true,"context_lines":[{"line_number":2452,"context_line":"        :param node: a node within the request body."},{"line_number":2453,"context_line":""},{"line_number":2454,"context_line":"        **Example Node creation request with a dynamic driver:**"},{"line_number":2455,"context_line":""},{"line_number":2456,"context_line":"        .. literalinclude:: samples/node-create-request-dynamic.json"},{"line_number":2457,"context_line":"           :language: javascript"},{"line_number":2458,"context_line":"        \"\"\""},{"line_number":2459,"context_line":"        if self.from_chassis:"}],"source_content_type":"text/x-python","patch_set":11,"id":"1b4f52f8_85abc13f","line":2456,"range":{"start_line":2455,"start_character":0,"end_line":2456,"end_character":68},"updated":"2022-03-09 18:08:04.000000000","message":"So lets try to use a relative path to point to the original sample isntead of the copy, so something like ../../../api-ref/samples/whatever/the/path/actually/is.inc.","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"9ad84fd659caed005b2fe3f965925f36ef00d91a","unresolved":false,"context_lines":[{"line_number":2452,"context_line":"        :param node: a node within the request body."},{"line_number":2453,"context_line":""},{"line_number":2454,"context_line":"        **Example Node creation request with a dynamic driver:**"},{"line_number":2455,"context_line":""},{"line_number":2456,"context_line":"        .. literalinclude:: samples/node-create-request-dynamic.json"},{"line_number":2457,"context_line":"           :language: javascript"},{"line_number":2458,"context_line":"        \"\"\""},{"line_number":2459,"context_line":"        if self.from_chassis:"}],"source_content_type":"text/x-python","patch_set":11,"id":"4deda10d_19717dd2","line":2456,"range":{"start_line":2455,"start_character":0,"end_line":2456,"end_character":68},"in_reply_to":"1b4f52f8_85abc13f","updated":"2022-03-11 15:40:43.000000000","message":"done","commit_id":"c105de10c94e1fb1f9648e1374f34bb3608e2b8c"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"958e2d90db2288715221bb5a673c6a393d217c7f","unresolved":true,"context_lines":[{"line_number":2451,"context_line":""},{"line_number":2452,"context_line":"        :param node: a node within the request body."},{"line_number":2453,"context_line":""},{"line_number":2454,"context_line":"        **Example Node creation request with a dynamic driver:**"},{"line_number":2455,"context_line":""},{"line_number":2456,"context_line":"        .. literalinclude::"},{"line_number":2457,"context_line":"           ../../../../api-ref/source/samples/node-create-request-dynamic.json"}],"source_content_type":"text/x-python","patch_set":12,"id":"64819d67_03aeaa63","line":2454,"range":{"start_line":2454,"start_character":39,"end_line":2454,"end_character":61},"updated":"2022-03-15 16:32:56.000000000","message":"I would just exclude references to driver type since there is only one type at this point.","commit_id":"fd9f0a93748457a38d8124a4dee0159de0c51c68"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"a3d79f747b3be4314638351d89a9dc56ee8b4e55","unresolved":false,"context_lines":[{"line_number":2451,"context_line":""},{"line_number":2452,"context_line":"        :param node: a node within the request body."},{"line_number":2453,"context_line":""},{"line_number":2454,"context_line":"        **Example Node creation request with a dynamic driver:**"},{"line_number":2455,"context_line":""},{"line_number":2456,"context_line":"        .. literalinclude::"},{"line_number":2457,"context_line":"           ../../../../api-ref/source/samples/node-create-request-dynamic.json"}],"source_content_type":"text/x-python","patch_set":12,"id":"77f27d1c_6a54868f","line":2454,"range":{"start_line":2454,"start_character":39,"end_line":2454,"end_character":61},"in_reply_to":"64819d67_03aeaa63","updated":"2022-03-16 20:24:39.000000000","message":"Done","commit_id":"fd9f0a93748457a38d8124a4dee0159de0c51c68"}],"requirements.txt":[{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"501a2474f6a58c4ea52fbbc833fe1e43aa1a6de5","unresolved":true,"context_lines":[{"line_number":44,"context_line":"tooz\u003e\u003d2.7.0 # Apache-2.0"},{"line_number":45,"context_line":"openstacksdk\u003e\u003d0.48.0 # Apache-2.0"},{"line_number":46,"context_line":"sushy\u003e\u003d3.10.0"},{"line_number":47,"context_line":"ironic-lib\u003e\u003d4.0.0 # Apache-2.0"}],"source_content_type":"text/plain","patch_set":5,"id":"1993b7da_75a2c784","line":47,"updated":"2022-02-23 16:41:58.000000000","message":"This is duplicating line 13.","commit_id":"d77ffa5fd90ced2efe4464836e48ce5cdcfff788"},{"author":{"_account_id":34205,"name":"Mahnoor Asghar","email":"masghar.bese15seecs@seecs.edu.pk","username":"mudo"},"change_message_id":"1bfbd041e6a72be9bb0e7d1f94c563bb97780e45","unresolved":false,"context_lines":[{"line_number":44,"context_line":"tooz\u003e\u003d2.7.0 # Apache-2.0"},{"line_number":45,"context_line":"openstacksdk\u003e\u003d0.48.0 # Apache-2.0"},{"line_number":46,"context_line":"sushy\u003e\u003d3.10.0"},{"line_number":47,"context_line":"ironic-lib\u003e\u003d4.0.0 # Apache-2.0"}],"source_content_type":"text/plain","patch_set":5,"id":"f819b9e6_bdd358ad","line":47,"in_reply_to":"1993b7da_75a2c784","updated":"2022-02-25 16:49:32.000000000","message":"I see! Updated","commit_id":"d77ffa5fd90ced2efe4464836e48ce5cdcfff788"}]}