Add documentation for sys.flags

skinnyBat · skinnyBat · commit 8b657ab81e0d · 2019-05-19T10:32:07.000+12:00
diff --git a/derive/src/pyclass.rs b/derive/src/pyclass.rs
@@ -367,6 +367,7 @@ pub fn impl_pystruct_sequence(attr: AttributeArgs, item: Item) -> Result<TokenSt
                 };
                 methods.push(method);
                 let field_name_str = field_name.to_string();
+                // TODO add doc to the generated property
                 let method_reference = quote! {
                     class.set_str_attr(
                         #field_name_str,
diff --git a/vm/src/sysmodule.rs b/vm/src/sysmodule.rs
@@ -27,23 +27,41 @@ fn getframe(offset: OptionalArg<usize>, vm: &VirtualMachine) -> PyResult<FrameRe
     Ok(frame.clone())
 }
 
+/// sys.flags
+///
+/// Flags provided through command line arguments or environment vars.
 #[pystruct_sequence(name = "flags")]
 #[derive(Default, Debug)]
 struct SysFlags {
+    /// -d
     debug: bool,
+    /// -i
     inspect: bool,
+    /// -i
     interactive: bool,
+    /// -O or -OO
     optimize: u8,
+    /// -B
     dont_write_bytecode: bool,
+    /// -s
     no_user_site: bool,
+    /// -S
     no_site: bool,
+    /// -E
     ignore_environment: bool,
+    /// -v
     verbose: bool,
+    /// -b
     bytes_warning: bool,
+    /// -q
     quiet: bool,
+    /// -R
     hash_randomization: bool,
+    /// -I
     isolated: bool,
+    /// -X dev
     dev_mode: bool,
+    /// -X utf8
     utf8_mode: bool,
 }
 
