-
-
Notifications
You must be signed in to change notification settings - Fork 83
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clean up documentation output #322
Comments
Hi Adam, can I provide you some help with this? |
@RobbeRamon yes that'd be great if you could look into this. Do you need some guidance on where to start? |
I definitely could use some guidance given that this will be my first deep dive into this codebase |
I'll write something up tomorrow |
@RobbeRamon The contexts are created in AWSService.swift. There are a number of places where comments are generated inside the contexts. They all call self.stripHTMLTags(docs)?.split(separator: "\n") ?? [] which strips all the HTML tags from the docs and splits the text on all newlines, giving you an array of First thing I would do is break this off into a separate function and use this function throughout, not sure why I haven't done this already. You can then use this function as the base for all your work. While developing you probably don't want to be re-creating all the services on every run it is a very expensive operation that creates 900,000 lines of code. If you are running of a laptop it will kill your battery. You can limit to just outputting one service by using the command line argument
I include the I've added some thoughts on what needs to be done to clean up code in the main comment of this issue. Given code generation is already an expensive operation trying to keep your code as optimal as you can. I don't really want to see code generation time double, but I also understand this work will have impact on code generation speed. Oh and finally if you need any more guidance please ask and thank you for the offer of doing this |
Currently it just strips out all the html tags and outputs that. Which means for some API documentation it just creates super long lines of text, which Xcode turns into a wall of text which is unreadable.
<p>,<h*>
tags<li>
tags<a>
tagsThe text was updated successfully, but these errors were encountered: