Certain documented helpers are nowhere to be found

[Qonstrukt]

The documentation mentions some helpers for vacuuming like WithVacuumOnStartup which I did manually before, so they sound helpful:

Akavache/docs/configuration.md

Line 229 in afe0e9f

.WithVacuumOnStartup(true)

But I can't find any references to it in the code (I wanted to see what it does exactly), so it also can't be found in any of the libraries while trying to use it. What nice functionalities are you keeping from us? 😉

[Aidan63]

I've also noticed that the config docs uses a function called WithInMemoryProvider, but this function doesn't seem to exist either.

Akavache/docs/configuration.md

Line 50 in afe0e9f

.WithInMemoryProvider()

My IDE says that there is a WithInMemory though.

[glennawatson]

Thanks, we will do a bit of cleanup of the docs this weekend to remove these fake entries. Thanks for highlighting it.

[Aidan63]

Under "Advanced DI Patterns" (https://github.com/reactiveui/Akavache/blob/main/docs/configuration.md#advanced-di-patterns) the lambda passed into AddSingleton calls CreateCacheInstance which isn't mentioned anywhere else, is this another phantom function?

GitHub

Akavache/docs/configuration.md at main · reactiveui/Akavache

An asynchronous, persistent key-value store created for writing desktop and mobile applications, based on SQLite3. Akavache is great for both storing important data as well as cached local data tha...

[Aidan63]

More dodgy docs code. The settings docs gives an example of extending SettingsBase and then implementing the INPC interface, but the SettingsStorage class which SettingsBase inherits from already implements INPC and does all the work to raise notifications when values are changed. So I'm a bit confused as to what the that example / part of the doc is on about.
The example then goes on to say that SetOrCreate will return true if the value was changed, but SetOrCreate doesn't return a value so the example doesn't even compile...

https://github.com/reactiveui/Akavache/blob/main/docs/settings.md#settings-change-notifications

GitHub

Akavache/docs/settings.md at main · reactiveui/Akavache

An asynchronous, persistent key-value store created for writing desktop and mobile applications, based on SQLite3. Akavache is great for both storing important data as well as cached local data tha...

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.