Document empty namespaces #5039
Comments
gewarren
added
doc-enhancement
|
I was actually just about to start working on some documentation for System.Runtime.Intrinsics.*. I'm working on a project using intrinsics and had to figure everything out by using Intel's C intrinsics. |
@tannergooding are you okay with that? @stefanrbk this issue is just for the namespace summary and not any of its types. |
|
@gewarren I was going more towards the methods within the classes, but namespace level does make more sense as a place to start. Just a paragraph or so on the namespaces? I'm not sure what standards there may be on this. |
|
@stefanrbk We have guidelines for all the different fields here. |
|
I have posted PR #5055 for the |
|
@gewarren, I'm fine with users manually adding additional docs for the intrinsics. That being said, the official docs for the underlying instructions come from the Intel and AMD architecture manuals, which aren't available under an OSS license; so we likely need to be careful with taking certain contributions. The changes in #5055 don't look to fall into this category and are likely fine. |
Is there any possibility of any kind of expansion on the docs involving the instructions? I had to cross reference Intel's Intrinsics Guide to figure out how to use the instructions and figure out their names in C to locate the instructions in the docs to discover the dotnet name for each instruction I had to use. And if I forget something about an instruction in my code, I had to work in reverse to find it back in Intel's guide. It is a big hurdle to use processor features with so much potential! |
jeffhandley
added
the
area-Meta
Namespace summaries are documented in the ns-<namespace>.xml files. Some of these are empty and should be documented. Use the following order priority:
The text was updated successfully, but these errors were encountered: