package-benchmark icon indicating copy to clipboard operation
package-benchmark copied to clipboard

Improved Docs for iOS Projects?

Open iainsmith opened this issue 1 year ago • 5 comments

Thank you for producing such a wonderful package. I recently wanted to run some benchmarks that have a hard UIKit dependency, and I hit some issues when following the documentation which assumes a mac/linux environment (unless I missed something).

Given the prevalence of iOS swift code, having some additional documentation for this case would help get iOS teams onboarded.

iainsmith avatar Mar 11 '24 11:03 iainsmith

We'd be happy to take a PR if there's anything specific that needs to be taken into consideration- we currently don't work on iOS so hard to document for us. Any improvements appreciated.

hassila avatar Mar 11 '24 12:03 hassila

More concretely what was the problem?

hassila avatar Mar 11 '24 12:03 hassila

@ktoso seems you commented in context of some DA system, this issue is in context of Benchmark docs, probably ended up in wrong issue?

hassila avatar Mar 11 '24 20:03 hassila

Oh boy, ignore me -- I wrongly assumed this comment was in the distributed system package 😅 Let me remove the comment, it's just noise :)

ktoso avatar Mar 12 '24 00:03 ktoso

@iainsmith did you have any concrete suggestions on improvements? As mentioned above we don't use iOS ourselves...

hassila avatar Mar 27 '24 16:03 hassila

@iainsmith I tried to add the relevant iOS ifdefs here, not sure if that is enough for it to work as expected, but give it a try. Happy to take any other concrete suggestions on improvements, but as mentioned we don't do iOS so hard for us to know what's missing really... :-)

https://github.com/ordo-one/package-benchmark/releases/tag/1.23.4

hassila avatar May 22 '24 06:05 hassila