`attr_accessor` के लिए आधिकारिक दस्तावेज़ और 'मॉड्यूल' के अन्य तरीकों कहां हैं?

Question

कल answered a question कैसे attr_accessor काम करता है। मैं विधि के दस्तावेज से लिंक करना चाहता था, लेकिन मेरे आश्चर्य के लिए, didn't show upruby-doc.org पर। इसे Module.html में दस्तावेज नहीं किया जाना चाहिए? मैं बहुत यकीन है कि यह वहाँ ri Module#attr_accessor के रूप में एक बार गया था, और APIDock सही प्रलेखन दिखाने के लिए और एक Google search पहली हिट के बीच इस पेज पैदावार कर रहा हूँ।

अब मैं सोच रहा हूं: उन्होंने इस सामान्य विधि के दस्तावेज़ को क्यों हटाया (और Module#define_method जैसे अन्य महत्वपूर्ण तरीकों से भी)? और उन लोगों के लिए आधिकारिक दस्तावेज कहां है?

Answer 1

मैं ruby-doc.org की देखरेख के लिए एक ई-मेल लिखने का फैसला किया और पूछा इन तरीकों के लापता दस्तावेज के बारे में उन्हें। मुझे निम्नलिखित उत्तर प्राप्त हुआ:

वे निजी तरीके हैं, और डिफ़ॉल्ट रूप से rdoc आउटपुट में दिखाई नहीं देते हैं।

यह एक दुर्भाग्यपूर्ण स्थिति है, क्योंकि अधिकांश निजी तरीकों (जिसका उपयोग से बचा जाना चाहिए वे आम तौर पर कर रहे हैं के बाद से कार्यान्वयन विवरण, नहीं एक सार्वजनिक एपीआई का हिस्सा) attr_ * और इस तरह वास्तव में सामान्य उपयोग के लिए करना है के विपरीत है।

सुनिश्चित नहीं हैं कि क्या सही समाधान यहाँ है।

जेम्स

एक दूसरे मेल में:

मैं ग्रेग ब्राउन, एरिक Hodel, और कुछ अन्य लोगों को जो 1.9 के लिए rdocs सुधार करने के लिए काम कर रहा है के साथ इस पर चर्चा की।

आम सहमति है कि सभी निजी तरीकों का प्रदर्शन करने में है कि यह (शायद अनजाने) उपयोग तरीकों कि एक नाबालिग रिलीज से अगले करने के लिए बदलने के लिए उत्तरदायी हैं के लिए लोगों को प्रोत्साहित करेगा एक बुरा विचार होगा। लेकिन वे सराहना attr_ * की तरह निजी तरीके हैं कि, जबकि तकनीकी रूप से निजी, सार्वजनिक रास्ते का एक प्रकार में और उस डॉक्स डिफ़ॉल्ट रूप से प्रदर्शित करने की आवश्यकता पर इस्तेमाल किया।

मैं सी स्रोत कोड में इन के लिए कोड पर कुछ rdoc निर्देशों की स्थापना की कोशिश की, लेकिन यह कोई प्रभाव नहीं पड़ा।ऐसा लगता है कि की आवश्यकता है यह इंगित करने के लिए कुछ अतिरिक्त तरीका है कि, व्यवहारिक रूप से, एक विधि निजी है, लेकिन दस्तावेज़ों के लिए यह सार्वजनिक है।

मुझे यह देखने के लिए इसका पालन करना होगा कि 1.9 डॉक्टर-सुधार टीम कुछ भी हो गया है या नहीं।

धन्यवाद,

जेम्स ब्रिट

इसके अलावा अधिक जानकारी और इस मुद्दे के बारे में जेम्स द्वारा एक और बयान के लिए this thread देखते हैं। इस धागे में, वह यह भी कहता है कि :doc: निर्देश आमतौर पर आरडीओसी में उपलब्ध है ताकि रूबी कोड में इस सटीक समस्या को सी-लेवल प्रलेखन के लिए काम न लगे।

यह उत्तर समझदार लगता है। शायद वे इसे भविष्य में बदल देंगे।

Answer 2

apidoc version

मैं वहाँ से सब कुछ मिलता है।

ओह, तुम सवाल का संपादन किया।

हां, यह होना चाहिए, लेकिन ऐसा लगता है कि बहुत से सी विधियां अब और नहीं हैं।

Answer 3

सुंदर यकीन है कि यह आधिकारिक दस्तावेज नहीं है, लेकिन कम से कम डॉक्स हैं: http://apidock.com/ruby/

उदाहरण के लिए: http://apidock.com/ruby/Module/define_method