pravega-client-rust icon indicating copy to clipboard operation
pravega-client-rust copied to clipboard

Documentation for auth/tls enabled settings unclear

Open crazyzhou opened this issue 2 years ago • 1 comments

Problem description The stream manager in python client has two flags to turn on the auth and tls, but it is not mentioned in the documentation or code comments, especially this line is misleading which makes a bad example for users. https://github.com/pravega/pravega-client-rust/blob/e4e1ae7be9f7640e09aa4f77f4c73f2a11e08daa/python/src/stream_manager.rs#L38

Problem location stream_manager.rs

Suggestions for an improvement Add some more documentation to explain these two flags, and in the documentation PythonBindings.md and tests pravega_reader_test.py, it would be better to use explicit flag settings.

crazyzhou avatar Nov 16 '22 01:11 crazyzhou

hey, I want to solve this issue can you help me with how I can do it?

pushker001 avatar Nov 18 '22 16:11 pushker001