Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Penify] Full Repo Documentation #8

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

penify-dev[bot]
Copy link
Contributor

@penify-dev penify-dev bot commented Jul 2, 2024

This PR focuses exclusively on updating and refining the documentation throughout the codebase. There are no functional changes to the code itself.

Changes:
sandwich/sandwich-ktor/src/commonMain/kotlin/com/skydoves/sandwich/ktor/HttpStatementExtension.kt
sandwich/sandwich-ktor/src/commonMain/kotlin/com/skydoves/sandwich/ktor/ApiResponseExtension.kt
sandwich/sandwich-ktor/src/commonMain/kotlin/com/skydoves/sandwich/ktor/HttpClientExtension.kt
sandwich/sandwich-retrofit-datasource/src/test/kotlin/com/skydoves/sandwich/retrofit/datasource/DisneyClient.kt
sandwich/sandwich-retrofit-datasource/src/test/kotlin/com/skydoves/sandwich/retrofit/datasource/DisneyService.kt
sandwich/sandwich-retrofit-datasource/src/test/kotlin/com/skydoves/sandwich/retrofit/datasource/DisneyDataSourceService.kt
sandwich/sandwich-retrofit-datasource/src/test/kotlin/com/skydoves/sandwich/retrofit/datasource/ApiAbstract.kt
sandwich/sandwich-retrofit-datasource/src/test/kotlin/com/skydoves/sandwich/retrofit/datasource/DataSourceTest.kt
sandwich/sandwich-retrofit-datasource/src/test/kotlin/com/skydoves/sandwich/retrofit/datasource/DataSourceRawCallAdapterTest.kt
sandwich/sandwich-retrofit-datasource/src/main/kotlin/com/skydoves/sandwich/retrofit/datasource/ResponseDataSource.kt
sandwich/sandwich-retrofit-datasource/src/main/kotlin/com/skydoves/sandwich/retrofit/datasource/DataSource.kt
sandwich/sandwich-retrofit-datasource/src/main/kotlin/com/skydoves/sandwich/retrofit/datasource/DataSourceTransformer.kt
sandwich/sandwich-retrofit-datasource/src/main/kotlin/com/skydoves/sandwich/retrofit/datasource/ResponseTransformer.kt
sandwich/sandwich-retrofit-datasource/src/main/kotlin/com/skydoves/sandwich/retrofit/datasource/disposables/CompositeDisposable.kt
sandwich/sandwich-retrofit-datasource/src/main/kotlin/com/skydoves/sandwich/retrofit/datasource/disposables/DisposableTransformer.kt
sandwich/sandwich-retrofit-datasource/src/main/kotlin/com/skydoves/sandwich/retrofit/datasource/disposables/Disposable.kt
sandwich/sandwich-retrofit-datasource/src/main/kotlin/com/skydoves/sandwich/retrofit/datasource/adapters/DataSourceCallAdapterFactory.kt
sandwich/sandwich-retrofit-datasource/src/main/kotlin/com/skydoves/sandwich/retrofit/datasource/adapters/internal/DataSourceRawCallAdapter.kt
sandwich/sandwich-retrofit-datasource/src/main/kotlin/com/skydoves/sandwich/retrofit/datasource/adapters/internal/DataSourceCallAdapter.kt
sandwich/sandwich-retrofit-datasource/src/main/kotlin/com/skydoves/sandwich/retrofit/datasource/adapters/internal/DataSourceCallDelegate.kt
sandwich/sandwich-retrofit-datasource/src/main/kotlin/com/skydoves/sandwich/retrofit/datasource/executors/TaskExecutor.kt
sandwich/sandwich-retrofit-datasource/src/main/kotlin/com/skydoves/sandwich/retrofit/datasource/executors/ArchTaskExecutor.kt
sandwich/sandwich-retrofit-datasource/src/main/kotlin/com/skydoves/sandwich/retrofit/datasource/executors/DefaultTaskExecutor.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/MainViewModelFactory.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/MainRepository.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/SandwichDemoApp.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/MainViewModel.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/MainActivity.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/adapter/RecyclerViewBinding.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/adapter/PosterAdapter.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/datasource/MainDataSourceViewModel.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/datasource/MainDataSourceViewModelFactory.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/datasource/MainDataSourceActivity.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/mapper/SuccessPosterMapper.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/mapper/ErrorEnvelopeMapper.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/network/RequestInterceptor.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/network/DisneyService.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/network/KtorfitPokemonService.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/network/DisneyDataSourceService.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/operator/GlobalResponseOperator.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/operator/MainOperatorActivity.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/operator/CommonResponseOperator.kt
sandwich/app/src/main/kotlin/com/skydoves/sandwichdemo/operator/MainOperatorViewModelFactory.kt
sandwich/sandwich-retrofit/src/test/kotlin/com/skydoves/sandwich/ApiResponseExtensionsTest.kt
sandwich/sandwich-retrofit/src/test/kotlin/com/skydoves/sandwich/DisneyClient.kt
sandwich/sandwich-retrofit/src/test/kotlin/com/skydoves/sandwich/DisneyService.kt
sandwich/sandwich-retrofit/src/test/kotlin/com/skydoves/sandwich/SuccessPosterMapper.kt
sandwich/sandwich-retrofit/src/test/kotlin/com/skydoves/sandwich/ApiResponseTest.kt
sandwich/sandwich-retrofit/src/test/kotlin/com/skydoves/sandwich/NoContentExceptionTest.kt
sandwich/sandwich-retrofit/src/test/kotlin/com/skydoves/sandwich/ErrorEnvelopeMapper.kt
sandwich/sandwich-retrofit/src/test/kotlin/com/skydoves/sandwich/ApiResponseSuspendTest.kt
sandwich/sandwich-retrofit/src/test/kotlin/com/skydoves/sandwich/Poster.kt
sandwich/sandwich-retrofit/src/test/kotlin/com/skydoves/sandwich/MainCoroutinesRule.kt
sandwich/sandwich-retrofit/src/test/kotlin/com/skydoves/sandwich/DisneyCoroutinesService.kt
sandwich/sandwich-retrofit/src/test/kotlin/com/skydoves/sandwich/SandwichInitializerTest.kt
sandwich/sandwich-retrofit/src/test/kotlin/com/skydoves/sandwich/ApiAbstract.kt
sandwich/sandwich-retrofit/src/test/kotlin/com/skydoves/sandwich/ApiResponseRetryTest.kt
sandwich/sandwich-retrofit/src/test/kotlin/com/skydoves/sandwich/ResponseTransformerTest.kt
sandwich/sandwich-retrofit/src/main/kotlin/com/skydoves/sandwich/retrofit/ApiResponseExtensions.kt
sandwich/sandwich-retrofit/src/main/kotlin/com/skydoves/sandwich/retrofit/ResponseTransformer.kt
sandwich/sandwich-retrofit/src/main/kotlin/com/skydoves/sandwich/retrofit/interceptors/EmptyBodyInterceptor.kt
sandwich/sandwich-retrofit/src/main/kotlin/com/skydoves/sandwich/retrofit/adapters/ApiResponseCallAdapterFactory.kt
sandwich/sandwich-retrofit/src/main/kotlin/com/skydoves/sandwich/retrofit/adapters/internal/ApiResponseCallAdapter.kt
sandwich/sandwich-retrofit/src/main/kotlin/com/skydoves/sandwich/retrofit/adapters/internal/ApiResponseDeferredCallAdapter.kt
sandwich/sandwich-retrofit/src/main/kotlin/com/skydoves/sandwich/retrofit/adapters/internal/ApiResponseCallDelegate.kt
sandwich/sandwich-retrofit-serialization/src/test/kotlin/com/skydoves/sandwich/retrofit/serialization/SerializationExtensionsTest.kt
sandwich/sandwich-retrofit-serialization/src/main/kotlin/com/skydoves/sandwich/retrofit/serialization/SerializationExtensions.kt
sandwich/sandwich-ktorfit/src/commonMain/kotlin/com/skydoves/sandwich/ktorfit/ApiResponseConverterFactory.kt
sandwich/sandwich/src/commonMain/kotlin/com/skydoves/sandwich/ApiResponse.kt
sandwich/sandwich/src/commonMain/kotlin/com/skydoves/sandwich/retry/RetryPolicy.kt
sandwich/sandwich/src/commonMain/kotlin/com/skydoves/sandwich/retry/ApiResponseRetry.kt

🙏 Request:
Please review the changes to ensure that the documentation is clear, accurate, and adheres to your project's standards.
Any feedback regarding areas that might still need clarification or additional details would be highly appreciated.
You can also raise the request on the Penify Community or mail us at support@penify.dev

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

Successfully merging this pull request may close these issues.

0 participants