4
0
Эх сурвалжийг харах

src/lib.rs now we have the doc, uncomment lint warning for missing doc

Quentin Monnet 8 жил өмнө
parent
commit
ef53398f9c
2 өөрчлөгдсөн 1 нэмэгдсэн , 3 устгасан
  1. 0 1
      README.md
  2. 1 2
      src/lib.rs

+ 0 - 1
README.md

@@ -490,7 +490,6 @@ on your own.
 
 
 ## _To do_ list
 ## _To do_ list
 
 
-* Complete internal and API documentation.
 * Implement some traits (`Clone`, `Drop`, `Debug` are good candidate).
 * Implement some traits (`Clone`, `Drop`, `Debug` are good candidate).
 * Provide built-in support for user-space array and hash BPF maps.
 * Provide built-in support for user-space array and hash BPF maps.
 * Improve safety of JIT-compiled programs with runtime memory checks.
 * Improve safety of JIT-compiled programs with runtime memory checks.

+ 1 - 2
src/lib.rs

@@ -13,8 +13,7 @@
 #![doc(html_logo_url = "https://raw.githubusercontent.com/qmonnet/rbpf/master/rbpf.png",
 #![doc(html_logo_url = "https://raw.githubusercontent.com/qmonnet/rbpf/master/rbpf.png",
        html_favicon_url = "https://raw.githubusercontent.com/qmonnet/rbpf/master/rbpf.ico")]
        html_favicon_url = "https://raw.githubusercontent.com/qmonnet/rbpf/master/rbpf.ico")]
 
 
-// One day we'll uncomment this!
-// #![warn(missing_docs)]
+#![warn(missing_docs)]
 
 
 use std::u32;
 use std::u32;
 use std::collections::HashMap;
 use std::collections::HashMap;